Class: TD::Types::Supergroup

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

Overview

Represents a supergroup or channel with zero or more members (subscribers in the case of channels). From the point of view of the system, a channel is a special kind of a supergroup: only administrators can post and

see the list of members, and posts from all administrators use the name and photo of the channel instead of individual
names and profile photos.

Unlike supergroups, channels can have an unlimited number of subscribers.

Instance Attribute Summary collapse

Method Summary

Methods inherited from Base

#to_hash, #to_json

Instance Attribute Details

#boost_level ⇒ Integer

Approximate boost level for the chat.

Returns:

  • (Integer) —

    the current value of boost_level



50
51
52
 
# File 'lib/tdlib/types/supergroup.rb', line 50

def boost_level
  @boost_level
end

#date ⇒ Integer

Point in time (Unix timestamp) when the current user joined, or the point in time when the supergroup or channel was created, in case the user is not a member.

Returns:

  • (Integer) —

    the current value of date



50
51
52
 
# File 'lib/tdlib/types/supergroup.rb', line 50

def date
  @date
end

#has_active_stories ⇒ Boolean

True, if the supergroup or channel has non-expired stories available to the current user.

Returns:

  • (Boolean) —

    the current value of has_active_stories



50
51
52
 
# File 'lib/tdlib/types/supergroup.rb', line 50

def has_active_stories
  @has_active_stories
end

#has_linked_chat ⇒ Boolean

True, if the channel has a discussion group, or the supergroup is the designated discussion group for a channel.

Returns:

  • (Boolean) —

    the current value of has_linked_chat



50
51
52
 
# File 'lib/tdlib/types/supergroup.rb', line 50

def has_linked_chat
  @has_linked_chat
end

#has_location ⇒ Boolean

True, if the supergroup is connected to a location, i.e. the supergroup is a location-based supergroup.

Returns:

  • (Boolean) —

    the current value of has_location



50
51
52
 
# File 'lib/tdlib/types/supergroup.rb', line 50

def has_location
  @has_location
end

#has_sensitive_content ⇒ Boolean

True, if content of media messages in the supergroup or channel chat must be hidden with 18+ spoiler.

Returns:

  • (Boolean) —

    the current value of has_sensitive_content



50
51
52
 
# File 'lib/tdlib/types/supergroup.rb', line 50

def has_sensitive_content
  @has_sensitive_content
end

#has_unread_active_stories ⇒ Boolean

True, if the supergroup or channel has unread non-expired stories available to the current user.

Returns:

  • (Boolean) —

    the current value of has_unread_active_stories



50
51
52
 
# File 'lib/tdlib/types/supergroup.rb', line 50

def has_unread_active_stories
  @has_unread_active_stories
end

#id ⇒ Integer

Supergroup or channel identifier.

Returns:

  • (Integer) —

    the current value of id



50
51
52
 
# File 'lib/tdlib/types/supergroup.rb', line 50

def id
  @id
end

#is_broadcast_group ⇒ Boolean

True, if the supergroup is a broadcast group, i.e. only administrators can send messages and there is no limit on the number of members.

Returns:

  • (Boolean) —

    the current value of is_broadcast_group



50
51
52
 
# File 'lib/tdlib/types/supergroup.rb', line 50

def is_broadcast_group
  @is_broadcast_group
end

#is_channel ⇒ Boolean

True, if the supergroup is a channel.

Returns:

  • (Boolean) —

    the current value of is_channel



50
51
52
 
# File 'lib/tdlib/types/supergroup.rb', line 50

def is_channel
  @is_channel
end

#is_fake ⇒ Boolean

True, if many users reported this supergroup or channel as a fake account.

Returns:

  • (Boolean) —

    the current value of is_fake



50
51
52
 
# File 'lib/tdlib/types/supergroup.rb', line 50

def is_fake
  @is_fake
end

#is_forum ⇒ Boolean

True, if the supergroup is a forum with topics.

Returns:

  • (Boolean) —

    the current value of is_forum



50
51
52
 
# File 'lib/tdlib/types/supergroup.rb', line 50

def is_forum
  @is_forum
end

#is_scam ⇒ Boolean

True, if many users reported this supergroup or channel as a scam.

Returns:

  • (Boolean) —

    the current value of is_scam



50
51
52
 
# File 'lib/tdlib/types/supergroup.rb', line 50

def is_scam
  @is_scam
end

#is_slow_mode_enabled ⇒ Boolean

True, if the slow mode is enabled in the supergroup.

Returns:

  • (Boolean) —

    the current value of is_slow_mode_enabled



50
51
52
 
# File 'lib/tdlib/types/supergroup.rb', line 50

def is_slow_mode_enabled
  @is_slow_mode_enabled
end

#is_verified ⇒ Boolean

True, if the supergroup or channel is verified.

Returns:

  • (Boolean) —

    the current value of is_verified



50
51
52
 
# File 'lib/tdlib/types/supergroup.rb', line 50

def is_verified
  @is_verified
end

#join_by_request ⇒ Boolean

True, if all users directly joining the supergroup need to be approved by supergroup administrators. Always false for channels and supergroups without username, location, or a linked chat.

Returns:

  • (Boolean) —

    the current value of join_by_request



50
51
52
 
# File 'lib/tdlib/types/supergroup.rb', line 50

def join_by_request
  @join_by_request
end

#join_to_send_messages ⇒ Boolean

True, if users need to join the supergroup before they can send messages. Always true for channels and non-discussion supergroups.

Returns:

  • (Boolean) —

    the current value of join_to_send_messages



50
51
52
 
# File 'lib/tdlib/types/supergroup.rb', line 50

def join_to_send_messages
  @join_to_send_messages
end

#member_count ⇒ Integer

Number of members in the supergroup or channel; 0 if unknown. Currently, it is guaranteed to be known only if the supergroup or channel was received through getChatSimilarChats, getChatsToSendStories, getCreatedPublicChats, getGroupsInCommon, getInactiveSupergroupChats, getRecommendedChats, getSuitableDiscussionChats, getUserPrivacySettingRules, getVideoChatAvailableParticipants, searchChatsNearby, searchPublicChats, or in chatFolderInviteLinkInfo.missing_chat_ids, or in userFullInfo.personal_chat_id, or for chats with messages or stories from PublicForwards and foundStories.

Returns:

  • (Integer) —

    the current value of member_count



50
51
52
 
# File 'lib/tdlib/types/supergroup.rb', line 50

def member_count
  @member_count
end

#restriction_reason ⇒ TD::Types::String

If non-empty, contains a human-readable description of the reason why access to this supergroup or channel must be restricted.

Returns:

  • (TD::Types::String) —

    the current value of restriction_reason



50
51
52
 
# File 'lib/tdlib/types/supergroup.rb', line 50

def restriction_reason
  @restriction_reason
end

#show_message_sender ⇒ Boolean

True, if messages sent to the channel have information about the sender user. This field is only applicable to channels.

Returns:

  • (Boolean) —

    the current value of show_message_sender



50
51
52
 
# File 'lib/tdlib/types/supergroup.rb', line 50

def show_message_sender
  @show_message_sender
end

#sign_messages ⇒ Boolean

True, if messages sent to the channel contains name of the sender. This field is only applicable to channels.

Returns:

  • (Boolean) —

    the current value of sign_messages



50
51
52
 
# File 'lib/tdlib/types/supergroup.rb', line 50

def sign_messages
  @sign_messages
end

#status ⇒ TD::Types::ChatMemberStatus

Status of the current user in the supergroup or channel; custom title will always be empty.

Returns:



50
51
52
 
# File 'lib/tdlib/types/supergroup.rb', line 50

def status
  @status
end

#usernames ⇒ TD::Types::Usernames?

Usernames of the supergroup or channel; may be null.

Returns:



50
51
52
 
# File 'lib/tdlib/types/supergroup.rb', line 50

def usernames
  @usernames
end