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

Inherits Object.

Description

A chat. (Can be a private chat, basic group, supergroup, or secret chat.)

Public Fields

int53 id_
 Chat unique identifier.
 
object_ptr< ChatTypetype_
 Type of the chat.
 
string title_
 Chat title.
 
object_ptr< chatPhotoInfophoto_
 Chat photo; may be null.
 
int32 accent_color_id_
 Identifier of the accent color for message sender name, and backgrounds of chat photo, reply header, and link preview.
 
int64 background_custom_emoji_id_
 Identifier of a custom emoji to be shown on the reply header and link preview background for messages sent by the chat; 0 if none.
 
int32 profile_accent_color_id_
 Identifier of the profile accent color for the chat's profile; -1 if none.
 
int64 profile_background_custom_emoji_id_
 Identifier of a custom emoji to be shown on the background of the chat's profile; 0 if none.
 
object_ptr< chatPermissionspermissions_
 Actions that non-administrator chat members are allowed to take in the chat.
 
object_ptr< messagelast_message_
 Last message in the chat; may be null if none or unknown.
 
array< object_ptr< chatPosition > > positions_
 Positions of the chat in chat lists.
 
array< object_ptr< ChatList > > chat_lists_
 Chat lists to which the chat belongs. A chat can have a non-zero position in a chat list even it doesn't belong to the chat list and have no position in a chat list even it belongs to the chat list.
 
object_ptr< MessageSendermessage_sender_id_
 Identifier of a user or chat that is selected to send messages in the chat; may be null if the user can't change message sender.
 
object_ptr< BlockListblock_list_
 Block list to which the chat is added; may be null if none.
 
bool has_protected_content_
 True, if chat content can't be saved locally, forwarded, or copied.
 
bool is_translatable_
 True, if translation of all messages in the chat must be suggested to the user.
 
bool is_marked_as_unread_
 True, if the chat is marked as unread.
 
bool view_as_topics_
 True, if the chat is a forum supergroup that must be shown in the "View as topics" mode, or Saved Messages chat that must be shown in the "View as chats".
 
bool has_scheduled_messages_
 True, if the chat has scheduled messages.
 
bool can_be_deleted_only_for_self_
 True, if the chat messages can be deleted only for the current user while other users will continue to see the messages.
 
bool can_be_deleted_for_all_users_
 True, if the chat messages can be deleted for all users.
 
bool can_be_reported_
 True, if the chat can be reported to Telegram moderators through reportChat or reportChatPhoto.
 
bool default_disable_notification_
 Default value of the disable_notification parameter, used when a message is sent to the chat.
 
int32 unread_count_
 Number of unread messages in the chat.
 
int53 last_read_inbox_message_id_
 Identifier of the last read incoming message.
 
int53 last_read_outbox_message_id_
 Identifier of the last read outgoing message.
 
int32 unread_mention_count_
 Number of unread messages with a mention/reply in the chat.
 
int32 unread_reaction_count_
 Number of messages with unread reactions in the chat.
 
object_ptr< chatNotificationSettingsnotification_settings_
 Notification settings for the chat.
 
object_ptr< ChatAvailableReactionsavailable_reactions_
 Types of reaction, available in the chat.
 
int32 message_auto_delete_time_
 Current message auto-delete or self-destruct timer setting for the chat, in seconds; 0 if disabled. Self-destruct timer in secret chats starts after the message or its content is viewed. Auto-delete timer in other chats starts from the send date.
 
object_ptr< emojiStatusemoji_status_
 Emoji status to be shown along with chat title; may be null.
 
object_ptr< chatBackgroundbackground_
 Background set for the chat; may be null if none.
 
string theme_name_
 If non-empty, name of a theme, set for the chat.
 
object_ptr< ChatActionBaraction_bar_
 Information about actions which must be possible to do through the chat action bar; may be null if none.
 
object_ptr< businessBotManageBarbusiness_bot_manage_bar_
 Information about bar for managing a business bot in the chat; may be null if none.
 
object_ptr< videoChatvideo_chat_
 Information about video chat of the chat.
 
object_ptr< chatJoinRequestsInfopending_join_requests_
 Information about pending join requests; may be null if none.
 
int53 reply_markup_message_id_
 Identifier of the message from which reply markup needs to be used; 0 if there is no default custom reply markup in the chat.
 
object_ptr< draftMessagedraft_message_
 A draft of a message in the chat; may be null if none.
 
string client_data_
 Application-specific data associated with the chat. (For example, the chat scroll position or local chat notification settings can be stored here.) Persistent if the message database is used.
 

Public Instance Methods

 chat ()
 
 chat (int53 id_, object_ptr< ChatType > &&type_, string const &title_, object_ptr< chatPhotoInfo > &&photo_, int32 accent_color_id_, int64 background_custom_emoji_id_, int32 profile_accent_color_id_, int64 profile_background_custom_emoji_id_, object_ptr< chatPermissions > &&permissions_, object_ptr< message > &&last_message_, array< object_ptr< chatPosition >> &&positions_, array< object_ptr< ChatList >> &&chat_lists_, object_ptr< MessageSender > &&message_sender_id_, object_ptr< BlockList > &&block_list_, bool has_protected_content_, bool is_translatable_, bool is_marked_as_unread_, bool view_as_topics_, bool has_scheduled_messages_, bool can_be_deleted_only_for_self_, bool can_be_deleted_for_all_users_, bool can_be_reported_, bool default_disable_notification_, int32 unread_count_, int53 last_read_inbox_message_id_, int53 last_read_outbox_message_id_, int32 unread_mention_count_, int32 unread_reaction_count_, object_ptr< chatNotificationSettings > &&notification_settings_, object_ptr< ChatAvailableReactions > &&available_reactions_, int32 message_auto_delete_time_, object_ptr< emojiStatus > &&emoji_status_, object_ptr< chatBackground > &&background_, string const &theme_name_, object_ptr< ChatActionBar > &&action_bar_, object_ptr< businessBotManageBar > &&business_bot_manage_bar_, object_ptr< videoChat > &&video_chat_, object_ptr< chatJoinRequestsInfo > &&pending_join_requests_, int53 reply_markup_message_id_, object_ptr< draftMessage > &&draft_message_, string const &client_data_)
 
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 = 830601369
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ chat() [1/2]

chat ( )

A chat. (Can be a private chat, basic group, supergroup, or secret chat.)

◆ chat() [2/2]

chat ( int53  id_,
object_ptr< ChatType > &&  type_,
string const &  title_,
object_ptr< chatPhotoInfo > &&  photo_,
int32  accent_color_id_,
int64  background_custom_emoji_id_,
int32  profile_accent_color_id_,
int64  profile_background_custom_emoji_id_,
object_ptr< chatPermissions > &&  permissions_,
object_ptr< message > &&  last_message_,
array< object_ptr< chatPosition >> &&  positions_,
array< object_ptr< ChatList >> &&  chat_lists_,
object_ptr< MessageSender > &&  message_sender_id_,
object_ptr< BlockList > &&  block_list_,
bool  has_protected_content_,
bool  is_translatable_,
bool  is_marked_as_unread_,
bool  view_as_topics_,
bool  has_scheduled_messages_,
bool  can_be_deleted_only_for_self_,
bool  can_be_deleted_for_all_users_,
bool  can_be_reported_,
bool  default_disable_notification_,
int32  unread_count_,
int53  last_read_inbox_message_id_,
int53  last_read_outbox_message_id_,
int32  unread_mention_count_,
int32  unread_reaction_count_,
object_ptr< chatNotificationSettings > &&  notification_settings_,
object_ptr< ChatAvailableReactions > &&  available_reactions_,
int32  message_auto_delete_time_,
object_ptr< emojiStatus > &&  emoji_status_,
object_ptr< chatBackground > &&  background_,
string const &  theme_name_,
object_ptr< ChatActionBar > &&  action_bar_,
object_ptr< businessBotManageBar > &&  business_bot_manage_bar_,
object_ptr< videoChat > &&  video_chat_,
object_ptr< chatJoinRequestsInfo > &&  pending_join_requests_,
int53  reply_markup_message_id_,
object_ptr< draftMessage > &&  draft_message_,
string const &  client_data_ 
)

A chat. (Can be a private chat, basic group, supergroup, or secret chat.)

Parameters
[in]id_Chat unique identifier.
[in]type_Type of the chat.
[in]title_Chat title.
[in]photo_Chat photo; may be null.
[in]accent_color_id_Identifier of the accent color for message sender name, and backgrounds of chat photo, reply header, and link preview.
[in]background_custom_emoji_id_Identifier of a custom emoji to be shown on the reply header and link preview background for messages sent by the chat; 0 if none.
[in]profile_accent_color_id_Identifier of the profile accent color for the chat's profile; -1 if none.
[in]profile_background_custom_emoji_id_Identifier of a custom emoji to be shown on the background of the chat's profile; 0 if none.
[in]permissions_Actions that non-administrator chat members are allowed to take in the chat.
[in]last_message_Last message in the chat; may be null if none or unknown.
[in]positions_Positions of the chat in chat lists.
[in]chat_lists_Chat lists to which the chat belongs. A chat can have a non-zero position in a chat list even it doesn't belong to the chat list and have no position in a chat list even it belongs to the chat list.
[in]message_sender_id_Identifier of a user or chat that is selected to send messages in the chat; may be null if the user can't change message sender.
[in]block_list_Block list to which the chat is added; may be null if none.
[in]has_protected_content_True, if chat content can't be saved locally, forwarded, or copied.
[in]is_translatable_True, if translation of all messages in the chat must be suggested to the user.
[in]is_marked_as_unread_True, if the chat is marked as unread.
[in]view_as_topics_True, if the chat is a forum supergroup that must be shown in the "View as topics" mode, or Saved Messages chat that must be shown in the "View as chats".
[in]has_scheduled_messages_True, if the chat has scheduled messages.
[in]can_be_deleted_only_for_self_True, if the chat messages can be deleted only for the current user while other users will continue to see the messages.
[in]can_be_deleted_for_all_users_True, if the chat messages can be deleted for all users.
[in]can_be_reported_True, if the chat can be reported to Telegram moderators through reportChat or reportChatPhoto.
[in]default_disable_notification_Default value of the disable_notification parameter, used when a message is sent to the chat.
[in]unread_count_Number of unread messages in the chat.
[in]last_read_inbox_message_id_Identifier of the last read incoming message.
[in]last_read_outbox_message_id_Identifier of the last read outgoing message.
[in]unread_mention_count_Number of unread messages with a mention/reply in the chat.
[in]unread_reaction_count_Number of messages with unread reactions in the chat.
[in]notification_settings_Notification settings for the chat.
[in]available_reactions_Types of reaction, available in the chat.
[in]message_auto_delete_time_Current message auto-delete or self-destruct timer setting for the chat, in seconds; 0 if disabled. Self-destruct timer in secret chats starts after the message or its content is viewed. Auto-delete timer in other chats starts from the send date.
[in]emoji_status_Emoji status to be shown along with chat title; may be null.
[in]background_Background set for the chat; may be null if none.
[in]theme_name_If non-empty, name of a theme, set for the chat.
[in]action_bar_Information about actions which must be possible to do through the chat action bar; may be null if none.
[in]business_bot_manage_bar_Information about bar for managing a business bot in the chat; may be null if none.
[in]video_chat_Information about video chat of the chat.
[in]pending_join_requests_Information about pending join requests; may be null if none.
[in]reply_markup_message_id_Identifier of the message from which reply markup needs to be used; 0 if there is no default custom reply markup in the chat.
[in]draft_message_A draft of a message in the chat; may be null if none.
[in]client_data_Application-specific data associated with the chat. (For example, the chat scroll position or local chat notification settings can be stored here.) Persistent if the message database is used.

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: