class Hamilton::Types::ChatInviteLink

Overview

Represents an invite link for a chat.

Included Modules

Hamilton::Types::Common
JSON::Serializable

Defined in:

types/chat_invite_link.cr

Constructors

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

Instance Method Summary

#creates_join_request : Bool
True, if users joining the chat via the link need to be approved by chat administrators.
#creates_join_request=(creates_join_request : Bool)
True, if users joining the chat via the link need to be approved by chat administrators.
#creator : Hamilton::Types::User
Creator of the link.
#creator=(creator : Hamilton::Types::User)
Creator of the link.
#expire_date : Int32 | Nil
Point in time (Unix timestamp) when the link will expire or has been expired.
#expire_date=(expire_date : Int32 | Nil)
Point in time (Unix timestamp) when the link will expire or has been expired.
#invite_link : String
The invite link.
#invite_link=(invite_link : String)
The invite link.
#is_primary : Bool
True, if the link is primary.
#is_primary=(is_primary : Bool)
True, if the link is primary.
#is_revoked : Bool
True, if the link is revoked.
#is_revoked=(is_revoked : Bool)
True, if the link is revoked.
#member_limit : Int32 | Nil
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 | Nil)
The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999.
#name : String | Nil
Invite link name.
#name=(name : String | Nil)
Invite link name.
#non_nil_fields : Array(String)
List of available non-nil fields.
#non_nil_fields=(non_nil_fields : Array(String))
List of available non-nil fields.
#pending_join_request_count : Int32 | Nil
Number of pending join requests created using this link.
#pending_join_request_count=(pending_join_request_count : Int32 | Nil)
Number of pending join requests created using this link.
#subscription_period : Int32 | Nil
The number of seconds the subscription will be active for before the next payment.
#subscription_period=(subscription_period : Int32 | Nil)
The number of seconds the subscription will be active for before the next payment.
#subscription_price : Int32 | Nil
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 | Nil)
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.

Instance methods inherited from class `Reference`

Instance methods inherited from class `Object`

Constructor Detail

def self.new(pull : JSON::PullParser) #

def self.new(params) #

def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

def self.new(**params) #

Instance Method Detail

def creates_join_request : Bool #

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

def creates_join_request=(creates_join_request : Bool) #

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

def creator : Hamilton::Types::User #

Creator of the link.

def creator=(creator : Hamilton::Types::User) #

Creator of the link.

def expire_date : Int32 | Nil #

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

def expire_date=(expire_date : Int32 | Nil) #

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

def 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 “…”.

def 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 “…”.

def is_primary : Bool #

True, if the link is primary.

def is_primary=(is_primary : Bool) #

True, if the link is primary.

def is_revoked : Bool #

True, if the link is revoked.

def is_revoked=(is_revoked : Bool) #

True, if the link is revoked.

def member_limit : Int32 | Nil #

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

def member_limit=(member_limit : Int32 | Nil) #

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

def name : String | Nil #

Invite link name.

def name=(name : String | Nil) #

Invite link name.

def non_nil_fields : Array(String) #

List of available non-nil fields.

def non_nil_fields=(non_nil_fields : Array(String)) #

List of available non-nil fields.

def pending_join_request_count : Int32 | Nil #

Number of pending join requests created using this link.

def pending_join_request_count=(pending_join_request_count : Int32 | Nil) #

Number of pending join requests created using this link.

def subscription_period : Int32 | Nil #

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

def subscription_period=(subscription_period : Int32 | Nil) #

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

def subscription_price : Int32 | Nil #

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.

def subscription_price=(subscription_price : Int32 | Nil) #