TDLib
Loading...
Searching...
No Matches
supergroup Class Referencefinal

Inherits Object.

Description

Represents a supergroup or channel with zero or more members (subscribers in the case of channels).

Public Member Functions

void store (TlStorerToString &s, const char *field_name) const final
 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_, object_ptr< ActiveStoryState > &&active_story_state_)
Public Member Functions inherited from TlObject
TlObject & operator= (const TlObject &)=delete
TlObject & operator= (TlObject &&)=default
virtual void store (TlStorerCalcLength &s) const
virtual void store (TlStorerUnsafe &s) const
 TlObject ()=default
 TlObject (const TlObject &)=delete
 TlObject (TlObject &&)=default
virtual ~TlObject ()=default

Public Attributes

object_ptr< ActiveStoryState > active_story_state_
 State of active stories of the supergroup or channel; may be null if there are no active stories.
int32 boost_level_
 Approximate boost level for the chat.
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.
bool has_automatic_translation_
 True, if automatic translation of messages is enabled in the channel.
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.
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.
int53 id_
 Supergroup or channel identifier.
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.
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_channel_
 True, if the supergroup is a channel, which can have an unlimited number of subscribers, but only administrators can post there and see the list of subscribers.
bool is_direct_messages_group_
 True, if the supergroup is a direct message group for a channel chat.
bool is_forum_
 True, if the supergroup is a forum with topics.
bool is_slow_mode_enabled_
 True, if the slow mode is enabled in the supergroup.
bool join_by_request_
 True, if all users directly joining the supergroup need to be approved by supergroup administrators.
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.
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.
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.
object_ptr< restrictionInfo > restriction_info_
 Information about the restrictions that must be applied to the corresponding supergroup or channel chat; may be null if none.
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 sign_messages_
 True, if messages sent to the channel contains name of the sender. This field is only applicable to channels.
object_ptr< ChatMemberStatus > status_
 Status of the current user in the supergroup or channel.
object_ptr< usernames > usernames_
 Usernames of the supergroup or channel; may be null.
object_ptr< verificationStatus > verification_status_
 Information about verification status of the supergroup or channel; may be null if none.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ supergroup() [1/2]

supergroup ( )

Represents a supergroup or channel with zero or more members (subscribers in the case of channels).

◆ 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_,
object_ptr< ActiveStoryState > && active_story_state_ )

Represents a supergroup or channel with zero or more members (subscribers in the case of channels).

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.
[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.
[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, which can have an unlimited number of subscribers, but only administrators can post there and see the list of subscribers.
[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]active_story_state_State of active stories of the supergroup or channel; may be null if there are no active stories.

Member Function 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: