peyk.platforms.telegram.types.chat_invite_link

Classes

ChatInviteLink(invite_link[, creator, ...])

Represents an invite link for a chat.

class peyk.platforms.telegram.types.chat_invite_link.ChatInviteLink(invite_link: str, creator: User | None = None, creates_join_request: bool | None = None, is_primary: bool | None = None, is_revoked: bool | None = None, name: str | None = None, expire_date: int | None = None, member_limit: int | None = None, pending_join_request_count: int | None = None, subscription_period: int | None = None, subscription_price: int | None = None)

Bases: object

Represents an invite link for a chat.

Variables:

• invite_link (str) – The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with ‘…’.

• creator (peyk.platforms.telegram.types.user.User | None) – Creator of the link

• creates_join_request (bool | None) – True, if users joining the chat via the link need to be approved by chat administrators

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

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

• name (str | None) – Invite link name

• expire_date (int | None) – Point in time (Unix timestamp) when the link will expire or has been expired

• member_limit (int | None) – The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999

• pending_join_request_count (int | None) – Number of pending join requests created using this link

• subscription_period (int | None) – The number of seconds the subscription will be active for before the next payment

• subscription_price (int | None) – The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat using the link

invite_link: str

creator: User | None = None

creates_join_request: bool | None = None

is_primary: bool | None = None

is_revoked: bool | None = None

name: str | None = None

expire_date: int | None = None

member_limit: int | None = None

pending_join_request_count: int | None = None

subscription_period: int | None = None

subscription_price: int | None = None

classmethod from_dict(data: dict | None) → ChatInviteLink | None

Parse a Telegram API mapping into this type.

Parameters:

data – Raw Telegram API mapping, or None.

Returns:

Parsed type instance, or None when data is None.