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

Inherits Function.

Description

Searches for messages in secret chats. Returns the results in reverse chronological order. For optimal performance, the number of returned messages is chosen by TDLib.

Returns object_ptr<FoundMessages>.

Public Fields

int53 chat_id_
 Identifier of the chat in which to search. Specify 0 to search in all secret chats.
 
string query_
 Query to search for. If empty, searchChatMessages must be used instead.
 
string offset_
 Offset of the first entry to return as received from the previous request; use empty string to get first chunk of results.
 
int32 limit_
 The maximum number of messages to be returned; up to 100. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit.
 
object_ptr< SearchMessagesFilterfilter_
 Additional filter for messages to search; pass null to search for all messages.
 

Public Types

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

Public Instance Methods

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

Constructor & Destructor Documentation

◆ searchSecretMessages() [1/2]

Default constructor for a function, which searches for messages in secret chats. Returns the results in reverse chronological order. For optimal performance, the number of returned messages is chosen by TDLib.

Returns object_ptr<FoundMessages>.

◆ searchSecretMessages() [2/2]

searchSecretMessages ( int53  chat_id_,
string const &  query_,
string const &  offset_,
int32  limit_,
object_ptr< SearchMessagesFilter > &&  filter_ 
)

Creates a function, which searches for messages in secret chats. Returns the results in reverse chronological order. For optimal performance, the number of returned messages is chosen by TDLib.

Returns object_ptr<FoundMessages>.

Parameters
[in]chat_id_Identifier of the chat in which to search. Specify 0 to search in all secret chats.
[in]query_Query to search for. If empty, searchChatMessages must be used instead.
[in]offset_Offset of the first entry to return as received from the previous request; use empty string to get first chunk of results.
[in]limit_The maximum number of messages to be returned; up to 100. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit.
[in]filter_Additional filter for messages to search; pass null to search for all messages.

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: