Skip to content

class Tourmaline::ChatInviteLink
inherits Reference #

Represents an invite link for a chat.

Included modules

JSON::Serializable

.new(invite_link, creator, creates_join_request, is_primary, is_revoked, name : String? = nil, expire_date : Int32 | Int64 | Nil = nil, member_limit : Int32 | Int64 | Nil = nil, pending_join_request_count : Int32 | Int64 | Nil = nil) #

View source

.new(pull : JSON::PullParser) #

View source

#creates_join_request=(creates_join_request : Bool) #

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

View source

#creates_join_request? : Bool #

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

View source

#creator : Tourmaline::User #

Creator of the link

View source

#creator=(creator : Tourmaline::User) #

Creator of the link

View source

#expire_date : Time? #

View source

#expire_date=(expire_date : Time?) #

View source

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

View source

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

View source

#is_primary=(is_primary : Bool) #

True, if the link is primary

View source

#is_primary? : Bool #

True, if the link is primary

View source

#is_revoked=(is_revoked : Bool) #

True, if the link is revoked

View source

#is_revoked? : Bool #

True, if the link is revoked

View source

#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

View source

#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

View source

#name : String? #

Optional. Invite link name

View source

#name=(name : String?) #

Optional. Invite link name

View source

#pending_join_request_count : Int32 | Int64 | Nil #

Optional. Number of pending join requests created using this link

View source

#pending_join_request_count=(pending_join_request_count : Int32 | Int64 | Nil) #

Optional. Number of pending join requests created using this link

View source