ChatFolder¶
Represents a folder for user chats
ChatFolder(
name: ChatFolderName,
icon: ChatFolderIcon,
color_id: int32,
is_shareable: Bool,
pinned_chat_ids: list of int53,
included_chat_ids: list of int53,
excluded_chat_ids: list of int53,
exclude_muted: Bool,
exclude_read: Bool,
exclude_archived: Bool,
include_contacts: Bool,
include_non_contacts: Bool,
include_bots: Bool,
include_groups: Bool,
include_channels: Bool
) → ChatFolder
name¶
The name of the folder
icon¶
The chosen icon for the chat folder; may be null. If null, use getChatFolderDefaultIconName to get default icon name for the folder
color_id¶
int32
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
is_shareable¶
Bool
True, if at least one link has been created for the folder
pinned_chat_ids¶
list of int53
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
included_chat_ids¶
list of int53
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
excluded_chat_ids¶
list of int53
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
exclude_muted¶
Bool
True, if muted chats need to be excluded
exclude_read¶
Bool
True, if read chats need to be excluded
exclude_archived¶
Bool
True, if archived chats need to be excluded
include_contacts¶
Bool
True, if contacts need to be included
include_non_contacts¶
Bool
True, if non-contact users need to be included
include_bots¶
Bool
True, if bots need to be included
include_groups¶
Bool
True, if basic groups and supergroups need to be included
include_channels¶
Bool
True, if channels need to be included