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::searchMessages Class Referencefinal

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

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

Public Types

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

Public Member Functions

 searchMessages ()
 
 searchMessages (object_ptr< ChatList > &&chat_list_, string const &query_, string const &offset_, int32 limit_, object_ptr< SearchMessagesFilter > &&filter_, object_ptr< SearchMessagesChatTypeFilter > &&chat_type_filter_, int32 min_date_, int32 max_date_)
 
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

object_ptr< ChatListchat_list_
 Chat list in which to search messages; pass null to search in all chats regardless of their chat list. Only Main and Archive chat lists are supported.
 
string query_
 Query to search for.
 
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. Filters searchMessagesFilterMention, searchMessagesFilterUnreadMention, searchMessagesFilterUnreadReaction, searchMessagesFilterUnreadPollVote, searchMessagesFilterFailedToSend, and searchMessagesFilterPinned are unsupported in this function.
 
object_ptr< SearchMessagesChatTypeFilterchat_type_filter_
 Additional filter for type of the chat of the searched messages; pass null to search for messages in all chats.
 
int32 min_date_
 If not 0, the minimum date of the messages to return.
 
int32 max_date_
 If not 0, the maximum date of the messages to return.
 

Static Public Attributes

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

Detailed Description

Searches for messages in all chats except secret chats. Returns the results in reverse chronological order (i.e., in order of decreasing (date, chat_id, message_id)). For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit.

Returns object_ptr<FoundMessages>.

Definition at line 124183 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 124237 of file td_api.h.

Constructor & Destructor Documentation

◆ searchMessages() [1/2]

td::td_api::searchMessages::searchMessages ( )

Default constructor for a function, which searches for messages in all chats except secret chats. Returns the results in reverse chronological order (i.e., in order of decreasing (date, chat_id, message_id)). For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit.

Returns object_ptr<FoundMessages>.

◆ searchMessages() [2/2]

td::td_api::searchMessages::searchMessages ( object_ptr< ChatList > &&  chat_list_,
string const &  query_,
string const &  offset_,
int32  limit_,
object_ptr< SearchMessagesFilter > &&  filter_,
object_ptr< SearchMessagesChatTypeFilter > &&  chat_type_filter_,
int32  min_date_,
int32  max_date_ 
)

Creates a function, which searches for messages in all chats except secret chats. Returns the results in reverse chronological order (i.e., in order of decreasing (date, chat_id, message_id)). For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit.

Returns object_ptr<FoundMessages>.

Parameters
[in]chat_list_Chat list in which to search messages; pass null to search in all chats regardless of their chat list. Only Main and Archive chat lists are supported.
[in]query_Query to search for.
[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. Filters searchMessagesFilterMention, searchMessagesFilterUnreadMention, searchMessagesFilterUnreadReaction, searchMessagesFilterUnreadPollVote, searchMessagesFilterFailedToSend, and searchMessagesFilterPinned are unsupported in this function.
[in]chat_type_filter_Additional filter for type of the chat of the searched messages; pass null to search for messages in all chats.
[in]min_date_If not 0, the minimum date of the messages to return.
[in]max_date_If not 0, the maximum date of the messages to return.

Member Function Documentation

◆ store()

void td::td_api::searchMessages::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_list_

object_ptr<ChatList> td::td_api::searchMessages::chat_list_

Chat list in which to search messages; pass null to search in all chats regardless of their chat list. Only Main and Archive chat lists are supported.

Definition at line 124194 of file td_api.h.

◆ chat_type_filter_

object_ptr<SearchMessagesChatTypeFilter> td::td_api::searchMessages::chat_type_filter_

Additional filter for type of the chat of the searched messages; pass null to search for messages in all chats.

Definition at line 124204 of file td_api.h.

◆ filter_

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

Additional filter for messages to search; pass null to search for all messages. Filters searchMessagesFilterMention, searchMessagesFilterUnreadMention, searchMessagesFilterUnreadReaction, searchMessagesFilterUnreadPollVote, searchMessagesFilterFailedToSend, and searchMessagesFilterPinned are unsupported in this function.

Definition at line 124202 of file td_api.h.

◆ ID

const std::int32_t td::td_api::searchMessages::ID = 1225448885
static

Identifier uniquely determining a type of the object.

Definition at line 124234 of file td_api.h.

◆ limit_

int32 td::td_api::searchMessages::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 124200 of file td_api.h.

◆ max_date_

int32 td::td_api::searchMessages::max_date_

If not 0, the maximum date of the messages to return.

Definition at line 124208 of file td_api.h.

◆ min_date_

int32 td::td_api::searchMessages::min_date_

If not 0, the minimum date of the messages to return.

Definition at line 124206 of file td_api.h.

◆ offset_

string td::td_api::searchMessages::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 124198 of file td_api.h.

◆ query_

string td::td_api::searchMessages::query_

Query to search for.

Definition at line 124196 of file td_api.h.


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