searchMessages Class Reference

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

Public Fields
object_ptr< ChatList >	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.
bool	only_in_channels_
	Pass true to search only for messages in channels.
string	query_
	Query to search for.
string	offset_
	Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results.
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< SearchMessagesFilter >	filter_
	Additional filter for messages to search; pass null to search for all messages. Filters searchMessagesFilterMention, searchMessagesFilterUnreadMention, searchMessagesFilterUnreadReaction, 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< foundMessages >
	Typedef for the type returned by the function.

Public Instance Methods
	searchMessages ()
	searchMessages (object_ptr< ChatList > &&chat_list_, bool only_in_channels_, string const &query_, string const &offset_, int32 limit_, object_ptr< SearchMessagesFilter > &&filter_, int32 min_date_, int32 max_date_)
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
TlObject &	operator= (const TlObject &)=delete
	TlObject (TlObject &&)=default
TlObject &	operator= (TlObject &&)=default
virtual	~TlObject ()=default

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

Constructor & Destructor Documentation

searchMessages() [1/2]

searchMessages

(

)

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

searchMessages() [2/2]

searchMessages	(	object_ptr< ChatList > &&	chat_list_,
		bool	only_in_channels_,
		string const &	query_,
		string const &	offset_,
		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<FoundMessages>.

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]	only_in_channels_	Pass true to search only for messages in channels.
[in]	query_	Query to search for.
[in]	offset_	Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results.
[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, searchMessagesFilterUnreadReaction, 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

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