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

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

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

Public Types

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

Public Member Functions

 searchSavedMessages ()
 
 searchSavedMessages (int53 saved_messages_topic_id_, object_ptr< ReactionType > &&tag_, string const &query_, int53 from_message_id_, int32 offset_, int32 limit_)
 
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 saved_messages_topic_id_
 If not 0, only messages in the specified Saved Messages topic will be considered; pass 0 to consider all messages.
 
object_ptr< ReactionTypetag_
 Tag to search for; pass null to return all suitable messages.
 
string query_
 Query to search for.
 
int53 from_message_id_
 Identifier of the message starting from which messages must be fetched; use 0 to get results from the last message.
 
int32 offset_
 Specify 0 to get results from exactly the message from_message_id or a negative number to get the specified message and some newer messages.
 
int32 limit_
 The maximum number of messages to be returned; must be positive and can&#x27;t be greater than 100. If the offset is negative, then the limit must be greater than -offset. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit.
 

Static Public Attributes

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

Detailed Description

Searches for messages tagged by the given reaction and with the given words in the Saved Messages chat; for Telegram Premium users only. Returns the results in reverse chronological order, i.e. in order of decreasing 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<FoundChatMessages>.

Definition at line 124811 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 124859 of file td_api.h.

Constructor & Destructor Documentation

◆ searchSavedMessages() [1/2]

td::td_api::searchSavedMessages::searchSavedMessages ( )

Default constructor for a function, which searches for messages tagged by the given reaction and with the given words in the Saved Messages chat; for Telegram Premium users only. Returns the results in reverse chronological order, i.e. in order of decreasing 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<FoundChatMessages>.

◆ searchSavedMessages() [2/2]

td::td_api::searchSavedMessages::searchSavedMessages ( int53  saved_messages_topic_id_,
object_ptr< ReactionType > &&  tag_,
string const &  query_,
int53  from_message_id_,
int32  offset_,
int32  limit_ 
)

Creates a function, which searches for messages tagged by the given reaction and with the given words in the Saved Messages chat; for Telegram Premium users only. Returns the results in reverse chronological order, i.e. in order of decreasing 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<FoundChatMessages>.

Parameters
[in]saved_messages_topic_id_If not 0, only messages in the specified Saved Messages topic will be considered; pass 0 to consider all messages.
[in]tag_Tag to search for; pass null to return all suitable messages.
[in]query_Query to search for.
[in]from_message_id_Identifier of the message starting from which messages must be fetched; use 0 to get results from the last message.
[in]offset_Specify 0 to get results from exactly the message from_message_id or a negative number to get the specified message and some newer messages.
[in]limit_The maximum number of messages to be returned; must be positive and can&#x27;t be greater than 100. If the offset is negative, then the limit must be greater than -offset. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit.

Member Function Documentation

◆ store()

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

◆ from_message_id_

int53 td::td_api::searchSavedMessages::from_message_id_

Identifier of the message starting from which messages must be fetched; use 0 to get results from the last message.

Definition at line 124828 of file td_api.h.

◆ ID

const std::int32_t td::td_api::searchSavedMessages::ID = -1969512554
static

Identifier uniquely determining a type of the object.

Definition at line 124856 of file td_api.h.

◆ limit_

int32 td::td_api::searchSavedMessages::limit_

The maximum number of messages to be returned; must be positive and can&#x27;t be greater than 100. If the offset is negative, then the limit must be greater than -offset. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit.

Definition at line 124832 of file td_api.h.

◆ offset_

int32 td::td_api::searchSavedMessages::offset_

Specify 0 to get results from exactly the message from_message_id or a negative number to get the specified message and some newer messages.

Definition at line 124830 of file td_api.h.

◆ query_

string td::td_api::searchSavedMessages::query_

Query to search for.

Definition at line 124826 of file td_api.h.

◆ saved_messages_topic_id_

int53 td::td_api::searchSavedMessages::saved_messages_topic_id_

If not 0, only messages in the specified Saved Messages topic will be considered; pass 0 to consider all messages.

Definition at line 124822 of file td_api.h.

◆ tag_

object_ptr<ReactionType> td::td_api::searchSavedMessages::tag_

Tag to search for; pass null to return all suitable messages.

Definition at line 124824 of file td_api.h.


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