tdlib-obf API
Reference documentation for the public tdlib-obf API, generated from TDLib schemas and public headers
Loading...
Searching...
No Matches
td::td_api::searchSecretMessages Class Referencefinal

#include </home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h>

Inheritance diagram for td::td_api::searchSecretMessages:
td::td_api::Function td::TlObject

Public Types

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

Public Member Functions

 searchSecretMessages ()
 
 searchSecretMessages (int53 chat_id_, string const &query_, string const &offset_, int32 limit_, object_ptr< SearchMessagesFilter > &&filter_)
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Member Functions inherited from td::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
 

Public Attributes

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 the 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.
 

Static Public Attributes

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

Detailed 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>.

Definition at line 124878 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 124923 of file td_api.h.

Constructor & Destructor Documentation

◆ searchSecretMessages() [1/2]

td::td_api::searchSecretMessages::searchSecretMessages ( )

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]

td::td_api::searchSecretMessages::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 the 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.

Member Function Documentation

◆ store()

void td::td_api::searchSecretMessages::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 td::TlObject.

Member Data Documentation

◆ chat_id_

int53 td::td_api::searchSecretMessages::chat_id_

Identifier of the chat in which to search. Specify 0 to search in all secret chats.

Definition at line 124889 of file td_api.h.

◆ filter_

object_ptr<SearchMessagesFilter> td::td_api::searchSecretMessages::filter_

Additional filter for messages to search; pass null to search for all messages.

Definition at line 124897 of file td_api.h.

◆ ID

const std::int32_t td::td_api::searchSecretMessages::ID = -852865892
static

Identifier uniquely determining a type of the object.

Definition at line 124920 of file td_api.h.

◆ limit_

int32 td::td_api::searchSecretMessages::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.

Definition at line 124895 of file td_api.h.

◆ offset_

string td::td_api::searchSecretMessages::offset_

Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results.

Definition at line 124893 of file td_api.h.

◆ query_

string td::td_api::searchSecretMessages::query_

Query to search for. If empty, searchChatMessages must be used instead.

Definition at line 124891 of file td_api.h.


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