chatFolder Class Reference

Inherits Object.

Description

Represents a folder for user chats.

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 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
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't be changed if folder tags are disabled or the current user doesn't have Telegram Premium subscription.
bool	exclude_archived_
	True, if archived chats need to be excluded.
bool	exclude_muted_
	True, if muted chats need to be excluded.
bool	exclude_read_
	True, if read chats need to be excluded.
array< int53 >	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.
object_ptr< chatFolderIcon >	icon_
	The chosen icon for the chat folder; may be null. If null, use getChatFolderDefaultIconName to get default icon name for the folder.
bool	include_bots_
	True, if bots need to be included.
bool	include_channels_
	True, if channels need to be included.
bool	include_contacts_
	True, if contacts need to be included.
bool	include_groups_
	True, if basic groups and supergroups need to be included.
bool	include_non_contacts_
	True, if non-contact users need to be included.
array< int53 >	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.
bool	is_shareable_
	True, if at least one link has been created for the folder.
object_ptr< chatFolderName >	name_
	The name of the folder.
array< int53 >	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.

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

Constructor & Destructor Documentation

chatFolder() [1/2]

chatFolder

(

)

Represents a folder for user chats.

chatFolder() [2/2]

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't be changed if folder tags are disabled or the current user doesn'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 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]	s	Storer to which object string representation will be appended.
[in]	field_name	Object field_name if applicable.

Implements TlObject.

---

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

• td/generate/auto/td/telegram/td_api.h