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

Inheritance diagram for td::td_api::searchChatMessages:

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 td::TlObject
virtual void	store (TlStorerUnsafe &s) const

virtual void	store (TlStorerCalcLength &s) const

	TlObject ()=default

	TlObject (const TlObject &)=delete

TlObject &	operator= (const TlObject &)=delete

	TlObject (TlObject &&)=default

TlObject &	operator= (TlObject &&)=default

virtual	~TlObject ()=default

Public Attributes
int53	chat_id_
	Identifier of the chat in which to search messages.

object_ptr< MessageTopic >	topic_id_
	Pass topic identifier to search messages only in specific topic; pass null to search for messages in all topics.

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.

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

object_ptr< SearchMessagesFilter >	filter_
	Additional filter for messages to search; pass null to search for all messages.

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

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

Definition at line 123596 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

using td::td_api::searchChatMessages::ReturnType = object_ptr<foundChatMessages>

Typedef for the type returned by the function.

Definition at line 123650 of file td_api.h.

Constructor & Destructor Documentation

◆ searchChatMessages() [1/2]

td::td_api::searchChatMessages::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]

td::td_api::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_
	)

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 td::td_api::searchChatMessages::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 td::TlObject.

Member Data Documentation

◆ chat_id_

int53 td::td_api::searchChatMessages::chat_id_

Identifier of the chat in which to search messages.

Definition at line 123607 of file td_api.h.

◆ filter_

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

Additional filter for messages to search; pass null to search for all messages.

Definition at line 123621 of file td_api.h.

◆ from_message_id_

int53 td::td_api::searchChatMessages::from_message_id_

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

Definition at line 123615 of file td_api.h.

◆ ID

const std::int32_t td::td_api::searchChatMessages::ID = 1072442212

static

Identifier uniquely determining a type of the object.

Definition at line 123647 of file td_api.h.

◆ limit_

int32 td::td_api::searchChatMessages::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.

Definition at line 123619 of file td_api.h.

◆ offset_

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

◆ query_

string td::td_api::searchChatMessages::query_

Query to search for.

Definition at line 123611 of file td_api.h.

◆ sender_id_

object_ptr<MessageSender> td::td_api::searchChatMessages::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.

Definition at line 123613 of file td_api.h.

◆ topic_id_

object_ptr<MessageTopic> td::td_api::searchChatMessages::topic_id_

Pass topic identifier to search messages only in specific topic; pass null to search for messages in all topics.

Definition at line 123609 of file td_api.h.

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

/home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ ReturnType

Constructor & Destructor Documentation

◆ searchChatMessages() [1/2]

◆ searchChatMessages() [2/2]

Member Function Documentation

◆ store()

Member Data Documentation

◆ chat_id_

◆ filter_

◆ from_message_id_

◆ ID

◆ limit_

◆ offset_

◆ query_

◆ sender_id_

◆ topic_id_