Folder.edit()

Folder.edit()

Bound method update_peers of Folder.

Use as a shortcut for:

await client.edit_folder(
    folder_id,
    name="New folder",
    included_chats=["me"]
)

Example

await folder.update(included_chats=["me"])
Parameters:

  • name (``str``, *optional*) – The text of the chat folder name, 1-12 characters without line feeds.

  • entities (List of :obj:`~pyrogram.types.MessageEntity`, *optional*) – Special entities like bold, italic, etc. that appear in the folder name.

  • parse_mode (:obj:`~pyrogram.enums.ParseMode`, *optional*) – By default, texts are parsed using both Markdown and HTML styles. You can combine both syntaxes together.

  • animate_custom_emoji (``bool``, *optional*) – True, if custom emoji in the name must be animated.

  • icon (``str``, *optional*) – The chosen icon for the chat folder.

  • color (:obj:`~pyrogram.enums.FolderColor`, *optional*) – The identifier of the chosen color for the chat folder icon. Can’t be changed if folder tags are disabled or the current user doesn’t have Telegram Premium subscription.

  • pinned_chats (List of ``int`` | ``str``, *optional*) – The 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_chats (List of ``int`` | ``str``, *optional*) – The 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_chats (List of ``int`` | ``str``, *optional*) – The 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``, *optional*) – True, if muted chats need to be excluded.

  • exclude_read (``bool``, *optional*) – True, if read chats need to be excluded.

  • exclude_archived (``bool``, *optional*) – True, if archived chats need to be excluded.

  • include_contacts (``bool``, *optional*) – True, if contacts need to be included.

  • include_non_contacts (``bool``, *optional*) – True, if non-contact users need to be included.

  • include_bots (``bool``, *optional*) – True, if bots need to be included.

  • include_groups (``bool``, *optional*) – True, if basic groups and supergroups need to be included.

  • include_channels (``bool``, *optional*) – True, if channels need to be included.

Returns:

True on success.