• Preparing search index...
  • The search index is not available
Documentation - v0.23.3
  • Documentation
  • @mtcute/node
  • methods
  • getInviteLinks

Function getInviteLinks

  • getInviteLinks(
        client: ITelegramClient,
        chatId: InputPeerLike,
        params?: {
            admin?: InputPeerLike;
            limit?: number;
            offset?: GetInviteLinksOffset;
            revoked?: boolean;
        },
    ): Promise<ArrayPaginated<ChatInviteLink, GetInviteLinksOffset>>
  • Get 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;
      }
      • 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

    Returns Promise<ArrayPaginated<ChatInviteLink, GetInviteLinksOffset>>

    • Defined in packages/core/src/highlevel/methods/invite-links/get-invite-links.ts:24

Settings

Member Visibility
Documentation - v0.23.3
  • Loading...

Generated using TypeDoc