python-telegram-bot Logo
13.14
  • telegram.ext package
  • telegram package
    • telegram.Animation
    • telegram.Audio
    • telegram.Bot
    • telegram.BotCommand
    • telegram.BotCommandScope
    • telegram.BotCommandScopeDefault
    • telegram.BotCommandScopeAllPrivateChats
    • telegram.BotCommandScopeAllGroupChats
    • telegram.BotCommandScopeAllChatAdministrators
    • telegram.BotCommandScopeChat
    • telegram.BotCommandScopeChatAdministrators
    • telegram.BotCommandScopeChatMember
    • telegram.CallbackQuery
    • telegram.Chat
    • telegram.ChatAdministratorRights
    • telegram.ChatAction
    • telegram.ChatInviteLink
    • telegram.ChatJoinRequest
    • telegram.ChatLocation
    • telegram.ChatMember
    • telegram.ChatMemberOwner
    • telegram.ChatMemberAdministrator
    • telegram.ChatMemberMember
    • telegram.ChatMemberRestricted
    • telegram.ChatMemberLeft
    • telegram.ChatMemberBanned
    • telegram.ChatMemberUpdated
    • telegram.ChatPermissions
    • telegram.ChatPhoto
    • telegram.constants Module
    • telegram.Contact
    • telegram.Dice
    • telegram.Document
    • telegram.error module
    • telegram.File
    • telegram.ForceReply
    • telegram.InlineKeyboardButton
    • telegram.InlineKeyboardMarkup
    • telegram.InputFile
    • telegram.InputMedia
    • telegram.InputMediaAnimation
    • telegram.InputMediaAudio
    • telegram.InputMediaDocument
    • telegram.InputMediaPhoto
    • telegram.InputMediaVideo
    • telegram.KeyboardButton
    • telegram.KeyboardButtonPollType
    • telegram.Location
    • telegram.LoginUrl
    • telegram.MenuButton
    • telegram.MenuButtonCommands
    • telegram.MenuButtonDefault
    • telegram.MenuButtonWebApp
    • telegram.Message
    • telegram.MessageAutoDeleteTimerChanged
    • telegram.MessageId
    • telegram.MessageEntity
    • telegram.ParseMode
    • telegram.PhotoSize
    • telegram.Poll
    • telegram.PollAnswer
    • telegram.PollOption
    • telegram.ProximityAlertTriggered
    • telegram.ReplyKeyboardRemove
    • telegram.ReplyKeyboardMarkup
    • telegram.ReplyMarkup
    • telegram.SentWebAppMessage
    • telegram.TelegramObject
    • telegram.Update
    • telegram.User
    • telegram.UserProfilePhotos
    • telegram.Venue
    • telegram.Video
    • telegram.VideoChatEnded
    • telegram.VideoChatParticipantsInvited
    • telegram.VideoChatScheduled
    • telegram.VideoChatStarted
    • telegram.VideoNote
    • telegram.Voice
    • telegram.VoiceChatStarted
    • telegram.VoiceChatEnded
    • telegram.VoiceChatScheduled
    • telegram.VoiceChatParticipantsInvited
    • telegram.WebAppData
    • telegram.WebAppInfo
    • telegram.WebhookInfo
    • Stickers
    • Inline Mode
    • Payments
    • Games
    • Passport
    • utils
  • Changelog
python-telegram-bot
  • telegram package
  • telegram.ChatInviteLink
  • Edit on GitHub

telegram.ChatInviteLink

class telegram.ChatInviteLink(invite_link, creator, is_primary, is_revoked, expire_date=None, member_limit=None, name=None, creates_join_request=None, pending_join_request_count=None, **_kwargs)

Bases: telegram.base.TelegramObject

This object represents an invite link for a chat.

Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their invite_link, creator, is_primary and is_revoked are equal.

New in version 13.4.

Parameters
  • invite_link (str) – The invite link.

  • creator (telegram.User) – Creator of the link.

  • is_primary (bool) – True, if the link is primary.

  • is_revoked (bool) – True, if the link is revoked.

  • expire_date (datetime.datetime, optional) – Date when the link will expire or has been expired.

  • member_limit (int, optional) – Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999.

  • name (str, optional) –

    Invite link name.

    New in version 13.8.

  • creates_join_request (bool, optional) –

    True, if users joining the chat via the link need to be approved by chat administrators.

    New in version 13.8.

  • pending_join_request_count (int, optional) –

    Number of pending join requests created using this link.

    New in version 13.8.

invite_link

The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with '…'.

Type

str

creator

Creator of the link.

Type

telegram.User

is_primary

True, if the link is primary.

Type

bool

is_revoked

True, if the link is revoked.

Type

bool

expire_date

Optional. Date when the link will expire or has been expired.

Type

datetime.datetime

member_limit

Optional. Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999.

Type

int

name

Optional. Invite link name.

New in version 13.8.

Type

str

creates_join_request

Optional. True, if users joining the chat via the link need to be approved by chat administrators.

New in version 13.8.

Type

bool

pending_join_request_count

Optional. Number of pending join requests created using this link.

New in version 13.8.

Type

int

classmethod de_json(data, bot)

See telegram.TelegramObject.de_json().

to_dict()

See telegram.TelegramObject.to_dict().

Previous Next

© Copyright 2015-2022, Leandro Toledo.

Built with Sphinx using a theme provided by Read the Docs.