Function getInviteLinkMembers

  • getInviteLinkMembers(
        client: ITelegramClient,
        chatId: InputPeerLike,
        params?: {
            limit?: number;
            link?: string | ChatInviteLink;
            offsetDate?: number | Date;
            offsetUser?: TypeInputUser;
            requested?: boolean;
            requestedSearch?: string;
        },
    ): Promise<
        ArrayPaginated<
            ChatInviteLinkMember,
            { date: number; user: tl.TypeInputUser },
        >,
    >

  • Iterate over users who have joined the chat with the given invite link.

    Parameters

    • client: ITelegramClient
    • chatId: InputPeerLike

      Chat ID

    • Optionalparams: {
          limit?: number;
          link?: string | ChatInviteLink;
          offsetDate?: number | Date;
          offsetUser?: TypeInputUser;
          requested?: boolean;
          requestedSearch?: string;
      }

      Additional params

      • Optionallimit?: number

        Maximum number of users to return

        Default

        100
      • Optionallink?: string | ChatInviteLink

        Invite link for which to get members

      • OptionaloffsetDate?: number | Date

        Offset request/join date used as an anchor for pagination.

      • OptionaloffsetUser?: TypeInputUser

        Offset user used as an anchor for pagination

      • Optionalrequested?: boolean

        Whether to get users who have requested to join the chat but weren't accepted yet

      • OptionalrequestedSearch?: string

        Search for a user in the pending join requests list (if passed, requested is assumed to be true)

        Doesn't work when link is set (Telegram limitation)

    Returns Promise<
        ArrayPaginated<
            ChatInviteLinkMember,
            { date: number; user: tl.TypeInputUser },
        >,
    >

Settings

Member Visibility