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

Inherits Function.

Description

Searches for a specified query in the first name, last name and usernames of the members of a specified chat. Requires administrator rights if the chat is a channel.

Returns object_ptr<ChatMembers>.

Public Fields

int53 chat_id_
 Chat identifier.
 
string query_
 Query to search for.
 
int32 limit_
 The maximum number of users to be returned; up to 200.
 
object_ptr< ChatMembersFilterfilter_
 The type of users to search for; pass null to search among all chat members.
 

Public Types

using ReturnType = object_ptr< chatMembers >
 Typedef for the type returned by the function.
 

Public Instance Methods

 searchChatMembers ()
 
 searchChatMembers (int53 chat_id_, string const &query_, int32 limit_, object_ptr< ChatMembersFilter > &&filter_)
 
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 = -445823291
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ searchChatMembers() [1/2]

Default constructor for a function, which searches for a specified query in the first name, last name and usernames of the members of a specified chat. Requires administrator rights if the chat is a channel.

Returns object_ptr<ChatMembers>.

◆ searchChatMembers() [2/2]

searchChatMembers ( int53  chat_id_,
string const &  query_,
int32  limit_,
object_ptr< ChatMembersFilter > &&  filter_ 
)

Creates a function, which searches for a specified query in the first name, last name and usernames of the members of a specified chat. Requires administrator rights if the chat is a channel.

Returns object_ptr<ChatMembers>.

Parameters
[in]chat_id_Chat identifier.
[in]query_Query to search for.
[in]limit_The maximum number of users to be returned; up to 200.
[in]filter_The type of users to search for; pass null to search among all chat members.

Method Documentation

◆ 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: