ChatFilter class

Represents a filter of user chats

Inheritance

Constructors

ChatFilter({String? extra, int? client_id, string? title, string? icon_name, vector<int53>? pinned_chat_ids, vector<int53>? included_chat_ids, vector<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})
ChatFilter.fromMap(Map<String, dynamic> map)

Properties

client_id int?
TDLib client id; maps to the field @client_id.
getter/setter pairinherited
exclude_archived Bool?
True, if archived chats need to be excluded
getter/setter pair
exclude_muted Bool?
True, if muted chats need to be excluded
getter/setter pair
exclude_read Bool?
True, if read chats need to be excluded
getter/setter pair
excluded_chat_ids vector<int53>?
The chat identifiers of always excluded chats in the filtered chat list. There can be up to getOption("chat_filter_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
getter/setter pair
extra String?
Matches requests with responses; maps to the field @extra.
getter/setter pairinherited
hashCode int
The hash code for this object.
no setterinherited
icon_name string?
The chosen icon name for short filter representation. If non-empty, must be one of "All", "Unread", "Unmuted", "Bots", "Channels", "Groups", "Private", "Custom", "Setup", "Cat", "Crown", "Favorite", "Flower", "Game", "Home", "Love", "Mask", "Party", "Sport", "Study", "Trade", "Travel", "Work", "Airplane", "Book", "Light", "Like", "Money", "Note", "Palette". If empty, use getChatFilterDefaultIconName to get default icon name for the filter
getter/setter pair
include_bots Bool?
True, if bots need to be included
getter/setter pair
include_channels Bool?
True, if channels need to be included
getter/setter pair
include_contacts Bool?
True, if contacts need to be included
getter/setter pair
include_groups Bool?
True, if basic groups and supergroups need to be included
getter/setter pair
include_non_contacts Bool?
True, if non-contact users need to be included
getter/setter pair
included_chat_ids vector<int53>?
The chat identifiers of always included chats in the filtered chat list. There can be up to getOption("chat_filter_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
getter/setter pair
pinned_chat_ids vector<int53>?
The chat identifiers of pinned chats in the filtered chat list. There can be up to getOption("chat_filter_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
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
tdType String
JSON object type; maps to the field @type.
no setteroverride
title string?
The title of the filter; 1-12 characters without line feeds
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson({dynamic skipNulls = true}) String
Serialize a Td instance to a JSON string. If skipNulls is true the fields with null values are not serialized.
inherited
toMap({dynamic skipNulls = true}) Map<String, dynamic>
Create a Map from a Td instance.
override
toString({dynamic skipNulls = false}) String
A string representation of this object.
inherited

Operators

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