List of all members | Public Fields | Public Instance Methods | Static Public Attributes
chatFilter Class Referencefinal

Inherits Object.

Description

Represents a filter of user chats.

Public Fields

string title_
 The title of the filter; 1-12 characters without line feeds.
 
string icon_name_
 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". If empty, use getChatFilterDefaultIconName to get default icon name for the filter.
 
array< int53pinned_chat_ids_
 The chat identifiers of pinned chats in the filtered chat list.
 
array< int53included_chat_ids_
 The chat identifiers of always included chats in the filtered chat list.
 
array< int53excluded_chat_ids_
 The chat identifiers of always excluded chats in the filtered chat list.
 
bool exclude_muted_
 True, if muted chats need to be excluded.
 
bool exclude_read_
 True, if read chats need to be excluded.
 
bool exclude_archived_
 True, if archived chats need to be excluded.
 
bool include_contacts_
 True, if contacts need to be included.
 
bool include_non_contacts_
 True, if non-contact users need to be included.
 
bool include_bots_
 True, if bots need to be included.
 
bool include_groups_
 True, if basic groups and supergroups need to be included.
 
bool include_channels_
 True, if channels need to be included.
 

Public Instance Methods

 chatFilter ()
 
 chatFilter (string const &title_, string const &icon_name_, 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_)
 
std::int32_t get_id () const final
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Instance Methods inherited from TlObject
virtual void store (TlStorerUnsafe &s) const
 
virtual void store (TlStorerCalcLength &s) const
 
 TlObject ()=default
 
 TlObject (const TlObject &)=delete
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Static Public Attributes

static const std::int32_t ID = -664815123
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ chatFilter() [1/2]

Represents a filter of user chats.

◆ chatFilter() [2/2]

chatFilter ( string const &  title_,
string const &  icon_name_,
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 filter of user chats.

Parameters
[in]title_The title of the filter; 1-12 characters without line feeds.
[in]icon_name_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". If empty, use getChatFilterDefaultIconName to get default icon name for the filter.
[in]pinned_chat_ids_The chat identifiers of pinned chats in the filtered chat list.
[in]included_chat_ids_The chat identifiers of always included chats in the filtered chat list.
[in]excluded_chat_ids_The chat identifiers of always excluded chats in the filtered chat list.
[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.

Method Documentation

◆ get_id()

std::int32_t get_id ( ) const
inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns
this->ID.

Implements TlObject.

◆ 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]sStorer to which object string representation will be appended.
[in]field_nameObject field_name if applicable.

Implements TlObject.


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