Class: TD::Types::ChatInviteLink

Inherits:
Base
  • Object
show all
Defined in:
lib/tdlib/types/chat_invite_link.rb

Overview

Contains a chat invite link.

Instance Attribute Summary collapse

Method Summary

Methods inherited from Base

#to_hash, #to_json

Instance Attribute Details

#creates_join_requestBoolean

True, if the link only creates join request. If true, total number of joining members will be unlimited.

Returns:

  • (Boolean)

    the current value of creates_join_request



25
26
27
# File 'lib/tdlib/types/chat_invite_link.rb', line 25

def creates_join_request
  @creates_join_request
end

#creator_user_idInteger

User identifier of an administrator created the link.

Returns:

  • (Integer)

    the current value of creator_user_id



25
26
27
# File 'lib/tdlib/types/chat_invite_link.rb', line 25

def creator_user_id
  @creator_user_id
end

#dateInteger

Point in time (Unix timestamp) when the link was created.

Returns:

  • (Integer)

    the current value of date



25
26
27
# File 'lib/tdlib/types/chat_invite_link.rb', line 25

def date
  @date
end

#edit_dateInteger

Point in time (Unix timestamp) when the link was last edited; 0 if never or unknown.

Returns:

  • (Integer)

    the current value of edit_date



25
26
27
# File 'lib/tdlib/types/chat_invite_link.rb', line 25

def edit_date
  @edit_date
end

#expiration_dateInteger

Point in time (Unix timestamp) when the link will expire; 0 if never.

Returns:

  • (Integer)

    the current value of expiration_date



25
26
27
# File 'lib/tdlib/types/chat_invite_link.rb', line 25

def expiration_date
  @expiration_date
end

#expired_member_countInteger

Number of chat members, which joined the chat using the link, but have already left because of expired subscription; for subscription links only.

Returns:

  • (Integer)

    the current value of expired_member_count



25
26
27
# File 'lib/tdlib/types/chat_invite_link.rb', line 25

def expired_member_count
  @expired_member_count
end

Chat invite link.

Returns:

  • (TD::Types::String)

    the current value of invite_link



25
26
27
# File 'lib/tdlib/types/chat_invite_link.rb', line 25

def invite_link
  @invite_link
end

#is_primaryBoolean

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.

Returns:

  • (Boolean)

    the current value of is_primary



25
26
27
# File 'lib/tdlib/types/chat_invite_link.rb', line 25

def is_primary
  @is_primary
end

#is_revokedBoolean

True, if the link was revoked.

Returns:

  • (Boolean)

    the current value of is_revoked



25
26
27
# File 'lib/tdlib/types/chat_invite_link.rb', line 25

def is_revoked
  @is_revoked
end

#member_countInteger

Number of chat members, which joined the chat using the link.

Returns:

  • (Integer)

    the current value of member_count



25
26
27
# File 'lib/tdlib/types/chat_invite_link.rb', line 25

def member_count
  @member_count
end

#member_limitInteger

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.

Returns:

  • (Integer)

    the current value of member_limit



25
26
27
# File 'lib/tdlib/types/chat_invite_link.rb', line 25

def member_limit
  @member_limit
end

#nameTD::Types::String

Name of the link.

Returns:

  • (TD::Types::String)

    the current value of name



25
26
27
# File 'lib/tdlib/types/chat_invite_link.rb', line 25

def name
  @name
end

#pending_join_request_countInteger

Number of pending join requests created using this link.

Returns:

  • (Integer)

    the current value of pending_join_request_count



25
26
27
# File 'lib/tdlib/types/chat_invite_link.rb', line 25

def pending_join_request_count
  @pending_join_request_count
end

#subscription_pricingTD::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.

Returns:



25
26
27
# File 'lib/tdlib/types/chat_invite_link.rb', line 25

def subscription_pricing
  @subscription_pricing
end