searchChatMessages Class Reference

Inherits Function.

Description

Searches for messages with given words in the chat. Returns the results in reverse chronological order, i.e. in order of decreasing message_id. Cannot be used in secret chats with a non-empty query (searchSecretMessages must be used instead), or without an enabled message database. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit. A combination of query, sender_id, filter and topic_id search criteria is expected to be supported, only if it is required for Telegram official application implementation.

Returns object_ptr<FoundChatMessages>.

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

Public Member Functions
	searchChatMessages ()
	searchChatMessages (int53 chat_id_, object_ptr< MessageTopic > &&topic_id_, string const &query_, object_ptr< MessageSender > &&sender_id_, int53 from_message_id_, int32 offset_, int32 limit_, object_ptr< SearchMessagesFilter > &&filter_)
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	chat_id_
	Identifier of the chat in which to search messages.
object_ptr< SearchMessagesFilter >	filter_
	Additional filter for messages to search; pass null to search for all messages.
int53	from_message_id_
	Identifier of the message starting from which history 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.
object_ptr< MessageSender >	sender_id_
	Identifier of the sender of messages to search for; pass null to search for messages from any sender. Not supported in secret chats.
object_ptr< MessageTopic >	topic_id_
	Pass topic identifier to search messages only in specific topic; pass null to search for messages in all topics.

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

Constructor & Destructor Documentation

searchChatMessages() [1/2]

searchChatMessages

(

)

Default constructor for a function, which searches for messages with given words in the chat. Returns the results in reverse chronological order, i.e. in order of decreasing message_id. Cannot be used in secret chats with a non-empty query (searchSecretMessages must be used instead), or without an enabled message database. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit. A combination of query, sender_id, filter and topic_id search criteria is expected to be supported, only if it is required for Telegram official application implementation.

Returns object_ptr<FoundChatMessages>.

searchChatMessages() [2/2]

searchChatMessages	(	int53	chat_id_,
		object_ptr< MessageTopic > &&	topic_id_,
		string const &	query_,
		object_ptr< MessageSender > &&	sender_id_,
		int53	from_message_id_,
		int32	offset_,
		int32	limit_,
		object_ptr< SearchMessagesFilter > &&	filter_ )

Creates a function, which searches for messages with given words in the chat. Returns the results in reverse chronological order, i.e. in order of decreasing message_id. Cannot be used in secret chats with a non-empty query (searchSecretMessages must be used instead), or without an enabled message database. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit. A combination of query, sender_id, filter and topic_id search criteria is expected to be supported, only if it is required for Telegram official application implementation.

Returns object_ptr<FoundChatMessages>.

Parameters

[in]	chat_id_	Identifier of the chat in which to search messages.
[in]	topic_id_	Pass topic identifier to search messages only in specific topic; pass null to search for messages in all topics.
[in]	query_	Query to search for.
[in]	sender_id_	Identifier of the sender of messages to search for; pass null to search for messages from any sender. Not supported in secret chats.
[in]	from_message_id_	Identifier of the message starting from which history 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.
[in]	filter_	Additional filter for messages to search; pass null to search for all messages.

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