class

Tourmaline::ChatInviteLink

Inherits JSON::Serializable < Reference < Object

Represents an invite link for a chat.

Constructors

new(invite_link : String, creator : Tourmaline::User, creates_join_request : Bool, is_primary : Bool, is_revoked : Bool, name : String | Nil = nil, expire_date : Int32 | Int64 | Nil = nil, member_limit : Int32 | Int64 | Nil = nil, pending_join_request_count : Int32 | Int64 | Nil = nil, subscription_period : Int32 | Int64 | Nil = nil, subscription_price : Int32 | Int64 | Nil = nil)

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance methods

creates_join_request=(creates_join_request : Bool)

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

creates_join_request?

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

creator

Creator of the link

creator=(creator : Tourmaline::User)

Creator of the link

expire_date

Optional. Point in time (Unix timestamp) when the link will expire or has been expired

expire_date=(expire_date : Time | Nil)

Optional. Point in time (Unix timestamp) when the link will expire or has been expired

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 "...".

invite_link=(invite_link : String)

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

is_primary=(is_primary : Bool)

True, if the link is primary

is_primary?

True, if the link is primary

is_revoked=(is_revoked : Bool)

True, if the link is revoked

is_revoked?

True, if the link is revoked

member_limit

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

member_limit=(member_limit : Int32 | Int64 | Nil)

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

name

Optional. Invite link name

name=(name : String | Nil)

Optional. Invite link name

pending_join_request_count

Optional. Number of pending join requests created using this link

pending_join_request_count=(pending_join_request_count : Int32 | Int64 | Nil)

Optional. Number of pending join requests created using this link

subscription_period

Optional. The number of seconds the subscription will be active for before the next payment

subscription_period=(subscription_period : Int32 | Int64 | Nil)

Optional. The number of seconds the subscription will be active for before the next payment

subscription_price

Optional. 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

subscription_price=(subscription_price : Int32 | Int64 | Nil)

Optional. 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