ChatFolder class final

Represents a folder for user chats

Inheritance

Constructors

ChatFolder({required String title, ChatFolderIcon? icon, required int colorId, required bool isShareable, required List<int> pinnedChatIds, required List<int> includedChatIds, required List<int> excludedChatIds, required bool excludeMuted, required bool excludeRead, required bool excludeArchived, required bool includeContacts, required bool includeNonContacts, required bool includeBots, required bool includeGroups, required bool includeChannels, dynamic extra, int? clientId})
Represents a folder for user chats
const
ChatFolder.fromJson(Map<String, dynamic> json)
Parses a ChatFolder from TDLib JSON.
factory

Properties

clientId → int?
Identifier of the TDLib client that sent this object.
final
colorId → int
The identifier of the chosen color for the chat folder icon; from -1 to 6. If -1, then color is didabled
final
excludeArchived → bool
True, if archived chats need to be excluded
final
excludedChatIds → List<int>
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
final
excludeMuted → bool
True, if muted chats need to be excluded
final
excludeRead → bool
True, if read chats need to be excluded
final
extra → dynamic
"@extra" of the request this object answers.
final
hashCode → int
The hash code for this object.
no setterinherited
icon → ChatFolderIcon?
The chosen icon for the chat folder; may be null. If null, use getChatFolderDefaultIconName to get default icon name for the folder
final
includeBots → bool
True, if bots need to be included
final
includeChannels → bool
True, if channels need to be included
final
includeContacts → bool
True, if contacts need to be included
final
includedChatIds → List<int>
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
final
includeGroups → bool
True, if basic groups and supergroups need to be included
final
includeNonContacts → bool
True, if non-contact users need to be included
final
isShareable → bool
True, if at least one link has been created for the folder
final
pinnedChatIds → List<int>
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
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
title → String
The title of the folder; 1-12 characters without line feeds
final

Methods

copyWith({String? title, ChatFolderIcon? icon()?, int? colorId, bool? isShareable, List<int>? pinnedChatIds, List<int>? includedChatIds, List<int>? excludedChatIds, bool? excludeMuted, bool? excludeRead, bool? excludeArchived, bool? includeContacts, bool? includeNonContacts, bool? includeBots, bool? includeGroups, bool? includeChannels, dynamic extra, int? clientId}) → ChatFolder
Returns a copy with the given fields replaced. For a nullable field pass a function, e.g. field: () => null to clear it.
getConstructor() → String
TDLib type name, e.g. updateNewMessage.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Converts this object to TDLib JSON.
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

CONSTRUCTOR → const String
TDLib type name.