Class: TD::Types::ChatInviteLink
- Defined in:
- lib/tdlib/types/chat_invite_link.rb
Overview
Contains a chat invite link.
Instance Attribute Summary collapse
-
#creates_join_request ⇒ Boolean
True, if the link only creates join request.
-
#creator_user_id ⇒ Integer
User identifier of an administrator created the link.
-
#date ⇒ Integer
Point in time (Unix timestamp) when the link was created.
-
#edit_date ⇒ Integer
Point in time (Unix timestamp) when the link was last edited; 0 if never or unknown.
-
#expiration_date ⇒ Integer
Point in time (Unix timestamp) when the link will expire; 0 if never.
-
#expired_member_count ⇒ Integer
Number of chat members, which joined the chat using the link, but have already left because of expired subscription; for subscription links only.
-
#invite_link ⇒ TD::Types::String
Chat invite link.
-
#is_primary ⇒ Boolean
True, if the link is primary.
-
#is_revoked ⇒ Boolean
True, if the link was revoked.
-
#member_count ⇒ Integer
Number of chat members, which joined the chat using the link.
-
#member_limit ⇒ Integer
The maximum number of members, which can join the chat using the link simultaneously; 0 if not limited.
-
#name ⇒ TD::Types::String
Name of the link.
-
#pending_join_request_count ⇒ Integer
Number of pending join requests created using this link.
-
#subscription_pricing ⇒ TD::Types::StarSubscriptionPricing?
Information about subscription plan that is applied to the users joining the chat by the link; may be null if the link doesn’t require subscription.
Method Summary
Methods inherited from Base
Instance Attribute Details
#creates_join_request ⇒ Boolean
True, if the link only creates join request. If true, total number of joining members will be unlimited.
25 26 27 |
# File 'lib/tdlib/types/chat_invite_link.rb', line 25 def creates_join_request @creates_join_request end |
#creator_user_id ⇒ Integer
User identifier of an administrator created the link.
25 26 27 |
# File 'lib/tdlib/types/chat_invite_link.rb', line 25 def creator_user_id @creator_user_id end |
#date ⇒ Integer
Point in time (Unix timestamp) when the link was created.
25 26 27 |
# File 'lib/tdlib/types/chat_invite_link.rb', line 25 def date @date end |
#edit_date ⇒ Integer
Point in time (Unix timestamp) when the link was last edited; 0 if never or unknown.
25 26 27 |
# File 'lib/tdlib/types/chat_invite_link.rb', line 25 def edit_date @edit_date end |
#expiration_date ⇒ Integer
Point in time (Unix timestamp) when the link will expire; 0 if never.
25 26 27 |
# File 'lib/tdlib/types/chat_invite_link.rb', line 25 def expiration_date @expiration_date end |
#expired_member_count ⇒ Integer
Number of chat members, which joined the chat using the link, but have already left because of expired subscription; for subscription links only.
25 26 27 |
# File 'lib/tdlib/types/chat_invite_link.rb', line 25 def expired_member_count @expired_member_count end |
#invite_link ⇒ TD::Types::String
Chat invite link.
25 26 27 |
# File 'lib/tdlib/types/chat_invite_link.rb', line 25 def invite_link @invite_link end |
#is_primary ⇒ Boolean
True, if the link is primary. Primary invite link can’t have name, expiration date, or usage limit. There is exactly one primary invite link for each administrator with can_invite_users right at a given time.
25 26 27 |
# File 'lib/tdlib/types/chat_invite_link.rb', line 25 def is_primary @is_primary end |
#is_revoked ⇒ Boolean
True, if the link was revoked.
25 26 27 |
# File 'lib/tdlib/types/chat_invite_link.rb', line 25 def is_revoked @is_revoked end |
#member_count ⇒ Integer
Number of chat members, which joined the chat using the link.
25 26 27 |
# File 'lib/tdlib/types/chat_invite_link.rb', line 25 def member_count @member_count end |
#member_limit ⇒ Integer
The maximum number of members, which can join the chat using the link simultaneously; 0 if not limited. Always 0 if the link requires approval.
25 26 27 |
# File 'lib/tdlib/types/chat_invite_link.rb', line 25 def member_limit @member_limit end |
#name ⇒ TD::Types::String
Name of the link.
25 26 27 |
# File 'lib/tdlib/types/chat_invite_link.rb', line 25 def name @name end |
#pending_join_request_count ⇒ Integer
Number of pending join requests created using this link.
25 26 27 |
# File 'lib/tdlib/types/chat_invite_link.rb', line 25 def pending_join_request_count @pending_join_request_count end |
#subscription_pricing ⇒ TD::Types::StarSubscriptionPricing?
Information about subscription plan that is applied to the users joining the chat by the link; may be null if the link doesn’t require subscription.
25 26 27 |
# File 'lib/tdlib/types/chat_invite_link.rb', line 25 def subscription_pricing @subscription_pricing end |