List of all members | Public Fields | Public Instance Methods | Static Public Attributes
supergroup Class Referencefinal

Inherits Object.

Description

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.

Public Fields

int53 id_
 Supergroup or channel identifier.
 
object_ptr< usernamesusernames_
 Usernames of the supergroup or channel; may be null.
 
int32 date_
 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.
 
object_ptr< ChatMemberStatusstatus_
 Status of the current user in the supergroup or channel; custom title will always be empty.
 
int32 member_count_
 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, getChatsToPostStories, getCreatedPublicChats, getGroupsInCommon, getInactiveSupergroupChats, getRecommendedChats, getSuitableDiscussionChats, getUserPrivacySettingRules, getVideoChatAvailableParticipants, searchPublicChats, or in chatFolderInviteLinkInfo.missing_chat_ids, or in userFullInfo.personal_chat_id, or for chats with messages or stories from publicForwards and foundStories.
 
int32 boost_level_
 Approximate boost level for the chat.
 
bool has_automatic_translation_
 True, if automatic translation of messages is enabled in the channel.
 
bool has_linked_chat_
 True, if the channel has a discussion group, or the supergroup is the designated discussion group for a channel.
 
bool has_location_
 True, if the supergroup is connected to a location, i.e. the supergroup is a location-based supergroup.
 
bool sign_messages_
 True, if messages sent to the channel contains name of the sender. This field is only applicable to channels.
 
bool show_message_sender_
 True, if messages sent to the channel have information about the sender user. This field is only applicable to channels.
 
bool join_to_send_messages_
 True, if users need to join the supergroup before they can send messages. May be false only for discussion supergroups and channel direct messages groups.
 
bool join_by_request_
 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.
 
bool is_slow_mode_enabled_
 True, if the slow mode is enabled in the supergroup.
 
bool is_channel_
 True, if the supergroup is a channel.
 
bool is_broadcast_group_
 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.
 
bool is_forum_
 True, if the supergroup is a forum with topics.
 
bool is_direct_messages_group_
 True, if the supergroup is a direct message group for a channel chat.
 
bool is_administered_direct_messages_group_
 True, if the supergroup is a direct messages group for a channel chat that is administered by the current user.
 
object_ptr< verificationStatusverification_status_
 Information about verification status of the supergroup or channel; may be null if none.
 
bool has_direct_messages_group_
 True, if the channel has direct messages group.
 
bool has_forum_tabs_
 True, if the supergroup is a forum, which topics are shown in the same way as in channel direct messages groups.
 
object_ptr< restrictionInforestriction_info_
 Information about the restrictions that must be applied to the corresponding supergroup or channel chat; may be null if none.
 
int53 paid_message_star_count_
 Number of Telegram Stars that must be paid by non-administrator users of the supergroup chat for each sent message.
 
bool has_active_stories_
 True, if the supergroup or channel has non-expired stories available to the current user.
 
bool has_unread_active_stories_
 True, if the supergroup or channel has unread non-expired stories available to the current user.
 

Public Instance Methods

 supergroup ()
 
 supergroup (int53 id_, object_ptr< usernames > &&usernames_, int32 date_, object_ptr< ChatMemberStatus > &&status_, int32 member_count_, int32 boost_level_, bool has_automatic_translation_, bool has_linked_chat_, bool has_location_, bool sign_messages_, bool show_message_sender_, bool join_to_send_messages_, bool join_by_request_, bool is_slow_mode_enabled_, bool is_channel_, bool is_broadcast_group_, bool is_forum_, bool is_direct_messages_group_, bool is_administered_direct_messages_group_, object_ptr< verificationStatus > &&verification_status_, bool has_direct_messages_group_, bool has_forum_tabs_, object_ptr< restrictionInfo > &&restriction_info_, int53 paid_message_star_count_, bool has_active_stories_, bool has_unread_active_stories_)
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Instance Methods inherited from TlObject
virtual void store (TlStorerUnsafe &s) const
 
virtual void store (TlStorerCalcLength &s) const
 
 TlObject ()=default
 
 TlObject (const TlObject &)=delete
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Static Public Attributes

static const std::int32_t ID = 918071782
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ supergroup() [1/2]

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.

◆ supergroup() [2/2]

supergroup ( int53  id_,
object_ptr< usernames > &&  usernames_,
int32  date_,
object_ptr< ChatMemberStatus > &&  status_,
int32  member_count_,
int32  boost_level_,
bool  has_automatic_translation_,
bool  has_linked_chat_,
bool  has_location_,
bool  sign_messages_,
bool  show_message_sender_,
bool  join_to_send_messages_,
bool  join_by_request_,
bool  is_slow_mode_enabled_,
bool  is_channel_,
bool  is_broadcast_group_,
bool  is_forum_,
bool  is_direct_messages_group_,
bool  is_administered_direct_messages_group_,
object_ptr< verificationStatus > &&  verification_status_,
bool  has_direct_messages_group_,
bool  has_forum_tabs_,
object_ptr< restrictionInfo > &&  restriction_info_,
int53  paid_message_star_count_,
bool  has_active_stories_,
bool  has_unread_active_stories_ 
)

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.

Parameters
[in]id_Supergroup or channel identifier.
[in]usernames_Usernames of the supergroup or channel; may be null.
[in]date_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.
[in]status_Status of the current user in the supergroup or channel; custom title will always be empty.
[in]member_count_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, getChatsToPostStories, getCreatedPublicChats, getGroupsInCommon, getInactiveSupergroupChats, getRecommendedChats, getSuitableDiscussionChats, getUserPrivacySettingRules, getVideoChatAvailableParticipants, searchPublicChats, or in chatFolderInviteLinkInfo.missing_chat_ids, or in userFullInfo.personal_chat_id, or for chats with messages or stories from publicForwards and foundStories.
[in]boost_level_Approximate boost level for the chat.
[in]has_automatic_translation_True, if automatic translation of messages is enabled in the channel.
[in]has_linked_chat_True, if the channel has a discussion group, or the supergroup is the designated discussion group for a channel.
[in]has_location_True, if the supergroup is connected to a location, i.e. the supergroup is a location-based supergroup.
[in]sign_messages_True, if messages sent to the channel contains name of the sender. This field is only applicable to channels.
[in]show_message_sender_True, if messages sent to the channel have information about the sender user. This field is only applicable to channels.
[in]join_to_send_messages_True, if users need to join the supergroup before they can send messages. May be false only for discussion supergroups and channel direct messages groups.
[in]join_by_request_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.
[in]is_slow_mode_enabled_True, if the slow mode is enabled in the supergroup.
[in]is_channel_True, if the supergroup is a channel.
[in]is_broadcast_group_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.
[in]is_forum_True, if the supergroup is a forum with topics.
[in]is_direct_messages_group_True, if the supergroup is a direct message group for a channel chat.
[in]is_administered_direct_messages_group_True, if the supergroup is a direct messages group for a channel chat that is administered by the current user.
[in]verification_status_Information about verification status of the supergroup or channel; may be null if none.
[in]has_direct_messages_group_True, if the channel has direct messages group.
[in]has_forum_tabs_True, if the supergroup is a forum, which topics are shown in the same way as in channel direct messages groups.
[in]restriction_info_Information about the restrictions that must be applied to the corresponding supergroup or channel chat; may be null if none.
[in]paid_message_star_count_Number of Telegram Stars that must be paid by non-administrator users of the supergroup chat for each sent message.
[in]has_active_stories_True, if the supergroup or channel has non-expired stories available to the current user.
[in]has_unread_active_stories_True, if the supergroup or channel has unread non-expired stories available to the current user.

Method Documentation

◆ store()

void store ( TlStorerToString &  s,
const char *  field_name 
) const
finalvirtual

Helper function for to_string method. Appends string representation of the object to the storer.

Parameters
[in]sStorer to which object string representation will be appended.
[in]field_nameObject field_name if applicable.

Implements TlObject.


The documentation for this class was generated from the following file: