searchSavedMessages Class Reference

Inherits Function.

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

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 TlObject
TlObject &	operator= (const TlObject &)=delete
TlObject &	operator= (TlObject &&)=default
virtual void	store (TlStorerCalcLength &s) const
virtual void	store (TlStorerUnsafe &s) const
	TlObject ()=default
	TlObject (const TlObject &)=delete
	TlObject (TlObject &&)=default
virtual	~TlObject ()=default

Public Attributes
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	limit_
	The maximum number of messages to be returned; must be positive and can'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.
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.
string	query_
	Query to search for.
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< ReactionType >	tag_
	Tag to search for; pass null to return all suitable messages.

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

Constructor & Destructor Documentation

searchSavedMessages() [1/2]

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]

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'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 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]	s	Storer to which object string representation will be appended.
[in]	field_name	Object field_name if applicable.

Implements TlObject.

---

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

• td/generate/auto/td/telegram/td_api.h