tdlib-obf API
Reference documentation for the public tdlib-obf API, generated from TDLib schemas and public headers
Loading...
Searching...
No Matches
td::td_api::chatFolder Class Referencefinal

#include </home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h>

Inheritance diagram for td::td_api::chatFolder:
td::td_api::Object td::TlObject

Public Member Functions

 chatFolder ()
 
 chatFolder (object_ptr< chatFolderName > &&name_, object_ptr< chatFolderIcon > &&icon_, int32 color_id_, bool is_shareable_, array< int53 > &&pinned_chat_ids_, array< int53 > &&included_chat_ids_, array< int53 > &&excluded_chat_ids_, bool exclude_muted_, bool exclude_read_, bool exclude_archived_, bool include_contacts_, bool include_non_contacts_, bool include_bots_, bool include_groups_, bool include_channels_)
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Member Functions inherited from td::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
 

Public Attributes

object_ptr< chatFolderNamename_
 The name of the folder.
 
object_ptr< chatFolderIconicon_
 The chosen icon for the chat folder; may be null. If null, use getChatFolderDefaultIconName to get default icon name for the folder.
 
int32 color_id_
 The identifier of the chosen color for the chat folder icon; from -1 to 6. If -1, then color is disabled. Can&#x27;t be changed if folder tags are disabled or the current user doesn&#x27;t have Telegram Premium subscription.
 
bool is_shareable_
 True, if at least one link has been created for the folder.
 
array< int53pinned_chat_ids_
 The chat identifiers of pinned chats in the folder. There can be up to getOption("chat_folder_chosen_chat_count_max") pinned and always included non-secret chats and the same number of secret chats, but the limit can be increased with Telegram Premium.
 
array< int53included_chat_ids_
 The chat identifiers of always included chats in the folder. There can be up to getOption("chat_folder_chosen_chat_count_max") pinned and always included non-secret chats and the same number of secret chats, but the limit can be increased with Telegram Premium.
 
array< int53excluded_chat_ids_
 The chat identifiers of always excluded chats in the folder. There can be up to getOption("chat_folder_chosen_chat_count_max") always excluded non-secret chats and the same number of secret chats, but the limit can be increased with Telegram Premium.
 
bool exclude_muted_
 True, if muted chats need to be excluded.
 
bool exclude_read_
 True, if read chats need to be excluded.
 
bool exclude_archived_
 True, if archived chats need to be excluded.
 
bool include_contacts_
 True, if contacts need to be included.
 
bool include_non_contacts_
 True, if non-contact users need to be included.
 
bool include_bots_
 True, if bots need to be included.
 
bool include_groups_
 True, if basic groups and supergroups need to be included.
 
bool include_channels_
 True, if channels need to be included.
 

Static Public Attributes

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

Detailed Description

Represents a folder for user chats.

Definition at line 12891 of file td_api.h.

Constructor & Destructor Documentation

◆ chatFolder() [1/2]

td::td_api::chatFolder::chatFolder ( )

Represents a folder for user chats.

◆ chatFolder() [2/2]

td::td_api::chatFolder::chatFolder ( object_ptr< chatFolderName > &&  name_,
object_ptr< chatFolderIcon > &&  icon_,
int32  color_id_,
bool  is_shareable_,
array< int53 > &&  pinned_chat_ids_,
array< int53 > &&  included_chat_ids_,
array< int53 > &&  excluded_chat_ids_,
bool  exclude_muted_,
bool  exclude_read_,
bool  exclude_archived_,
bool  include_contacts_,
bool  include_non_contacts_,
bool  include_bots_,
bool  include_groups_,
bool  include_channels_ 
)

Represents a folder for user chats.

Parameters
[in]name_The name of the folder.
[in]icon_The chosen icon for the chat folder; may be null. If null, use getChatFolderDefaultIconName to get default icon name for the folder.
[in]color_id_The identifier of the chosen color for the chat folder icon; from -1 to 6. If -1, then color is disabled. Can&#x27;t be changed if folder tags are disabled or the current user doesn&#x27;t have Telegram Premium subscription.
[in]is_shareable_True, if at least one link has been created for the folder.
[in]pinned_chat_ids_The chat identifiers of pinned chats in the folder. There can be up to getOption("chat_folder_chosen_chat_count_max") pinned and always included non-secret chats and the same number of secret chats, but the limit can be increased with Telegram Premium.
[in]included_chat_ids_The chat identifiers of always included chats in the folder. There can be up to getOption("chat_folder_chosen_chat_count_max") pinned and always included non-secret chats and the same number of secret chats, but the limit can be increased with Telegram Premium.
[in]excluded_chat_ids_The chat identifiers of always excluded chats in the folder. There can be up to getOption("chat_folder_chosen_chat_count_max") always excluded non-secret chats and the same number of secret chats, but the limit can be increased with Telegram Premium.
[in]exclude_muted_True, if muted chats need to be excluded.
[in]exclude_read_True, if read chats need to be excluded.
[in]exclude_archived_True, if archived chats need to be excluded.
[in]include_contacts_True, if contacts need to be included.
[in]include_non_contacts_True, if non-contact users need to be included.
[in]include_bots_True, if bots need to be included.
[in]include_groups_True, if basic groups and supergroups need to be included.
[in]include_channels_True, if channels need to be included.

Member Function Documentation

◆ store()

void td::td_api::chatFolder::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 td::TlObject.

Member Data Documentation

◆ color_id_

int32 td::td_api::chatFolder::color_id_

The identifier of the chosen color for the chat folder icon; from -1 to 6. If -1, then color is disabled. Can&#x27;t be changed if folder tags are disabled or the current user doesn&#x27;t have Telegram Premium subscription.

Definition at line 12906 of file td_api.h.

◆ exclude_archived_

bool td::td_api::chatFolder::exclude_archived_

True, if archived chats need to be excluded.

Definition at line 12920 of file td_api.h.

◆ exclude_muted_

bool td::td_api::chatFolder::exclude_muted_

True, if muted chats need to be excluded.

Definition at line 12916 of file td_api.h.

◆ exclude_read_

bool td::td_api::chatFolder::exclude_read_

True, if read chats need to be excluded.

Definition at line 12918 of file td_api.h.

◆ excluded_chat_ids_

array<int53> td::td_api::chatFolder::excluded_chat_ids_

The chat identifiers of always excluded chats in the folder. There can be up to getOption("chat_folder_chosen_chat_count_max") always excluded non-secret chats and the same number of secret chats, but the limit can be increased with Telegram Premium.

Definition at line 12914 of file td_api.h.

◆ icon_

object_ptr<chatFolderIcon> td::td_api::chatFolder::icon_

The chosen icon for the chat folder; may be null. If null, use getChatFolderDefaultIconName to get default icon name for the folder.

Definition at line 12904 of file td_api.h.

◆ ID

const std::int32_t td::td_api::chatFolder::ID = 1596164696
static

Identifier uniquely determining a type of the object.

Definition at line 12959 of file td_api.h.

◆ include_bots_

bool td::td_api::chatFolder::include_bots_

True, if bots need to be included.

Definition at line 12926 of file td_api.h.

◆ include_channels_

bool td::td_api::chatFolder::include_channels_

True, if channels need to be included.

Definition at line 12930 of file td_api.h.

◆ include_contacts_

bool td::td_api::chatFolder::include_contacts_

True, if contacts need to be included.

Definition at line 12922 of file td_api.h.

◆ include_groups_

bool td::td_api::chatFolder::include_groups_

True, if basic groups and supergroups need to be included.

Definition at line 12928 of file td_api.h.

◆ include_non_contacts_

bool td::td_api::chatFolder::include_non_contacts_

True, if non-contact users need to be included.

Definition at line 12924 of file td_api.h.

◆ included_chat_ids_

array<int53> td::td_api::chatFolder::included_chat_ids_

The chat identifiers of always included chats in the folder. There can be up to getOption("chat_folder_chosen_chat_count_max") pinned and always included non-secret chats and the same number of secret chats, but the limit can be increased with Telegram Premium.

Definition at line 12912 of file td_api.h.

◆ is_shareable_

bool td::td_api::chatFolder::is_shareable_

True, if at least one link has been created for the folder.

Definition at line 12908 of file td_api.h.

◆ name_

object_ptr<chatFolderName> td::td_api::chatFolder::name_

The name of the folder.

Definition at line 12902 of file td_api.h.

◆ pinned_chat_ids_

array<int53> td::td_api::chatFolder::pinned_chat_ids_

The chat identifiers of pinned chats in the folder. There can be up to getOption("chat_folder_chosen_chat_count_max") pinned and always included non-secret chats and the same number of secret chats, but the limit can be increased with Telegram Premium.

Definition at line 12910 of file td_api.h.


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