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

Inherits Function.

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

Public Fields

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.
 
int32 offset_date_
 The date of the message starting from which the results need to be fetched. Use 0 or any date in the future to get results from the last message.
 
int53 offset_chat_id_
 The chat identifier of the last found message, or 0 for the first request.
 
int53 offset_message_id_
 The message identifier of the last found message, or 0 for the first request.
 
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, searchMessagesFilterFailedToSend and searchMessagesFilterPinned are unsupported in this function.
 
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.
 

Public Types

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

Public Instance Methods

 searchMessages ()
 
 searchMessages (object_ptr< ChatList > &&chat_list_, string const &query_, int32 offset_date_, int53 offset_chat_id_, int53 offset_message_id_, int32 limit_, object_ptr< SearchMessagesFilter > &&filter_, int32 min_date_, int32 max_date_)
 
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 = -225214062
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ searchMessages() [1/2]

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

◆ searchMessages() [2/2]

searchMessages ( object_ptr< ChatList > &&  chat_list_,
string const &  query_,
int32  offset_date_,
int53  offset_chat_id_,
int53  offset_message_id_,
int32  limit_,
object_ptr< SearchMessagesFilter > &&  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<Messages>.

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_date_The date of the message starting from which the results need to be fetched. Use 0 or any date in the future to get results from the last message.
[in]offset_chat_id_The chat identifier of the last found message, or 0 for the first request.
[in]offset_message_id_The message identifier of the last found message, or 0 for the first request.
[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, searchMessagesFilterFailedToSend and searchMessagesFilterPinned are unsupported in this function.
[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.

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: