Function iterInviteLinks

  • iterInviteLinks(
        client: ITelegramClient,
        chatId: InputPeerLike,
        params?: {
            admin?: InputPeerLike;
            limit?: number;
            offset?: GetInviteLinksOffset;
            revoked?: boolean;
        } & { chunkSize?: number; limit?: number },
    ): AsyncIterableIterator<ChatInviteLink>

  • Iterate over invite links created by some administrator in the chat.

    As an administrator you can only get your own links (i.e. adminId = "self"), as a creator you can get any other admin's links.

    Parameters

    • client: ITelegramClient
    • chatId: InputPeerLike

      Chat ID

    • Optionalparams: {
          admin?: InputPeerLike;
          limit?: number;
          offset?: GetInviteLinksOffset;
          revoked?: boolean;
      } & { chunkSize?: number; limit?: number }
      • Optionaladmin?: InputPeerLike

        Only return this admin's links.

        Default

        "self"

      • Optionallimit?: number

        Limit the number of invite links to be fetched.

        Default

        100
      • Optionaloffset?: GetInviteLinksOffset

        Offset for pagination.

      • Optionalrevoked?: boolean

        Whether to fetch revoked invite links

      • OptionalchunkSize?: number

        Size of chunks which are fetched. Usually not needed.

        Default

        100

      • Optionallimit?: number

        Limit the number of invite links to be fetched. By default, all links are fetched.

    Returns AsyncIterableIterator<ChatInviteLink>

Settings

Member Visibility