tdlib-obf API
Reference documentation for the public tdlib-obf API, generated from TDLib schemas and public headers
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
td::td_api::getChatSparseMessagePositions Class Referencefinal

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

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

Public Types

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

Public Member Functions

 getChatSparseMessagePositions ()
 
 getChatSparseMessagePositions (int53 chat_id_, object_ptr< SearchMessagesFilter > &&filter_, int53 from_message_id_, int32 limit_, int53 saved_messages_topic_id_)
 
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 return information about message positions.
 
object_ptr< SearchMessagesFilter > filter_
 Filter for message content. Filters searchMessagesFilterEmpty, searchMessagesFilterMention, searchMessagesFilterUnreadMention, searchMessagesFilterUnreadReaction, and searchMessagesFilterUnreadPollVote are unsupported in this function.
 
int53 from_message_id_
 The message identifier from which to return information about message positions.
 
int32 limit_
 The expected number of message positions to be returned; 50-2000. A smaller number of positions can be returned, if there are not enough appropriate messages.
 
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, or for chats other than Saved Messages.
 

Static Public Attributes

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

Detailed Description

Returns sparse positions of messages of the specified type in the chat to be used for shared media scroll implementation. Returns the results in reverse chronological order (i.e., in order of decreasing message_id). Cannot be used in secret chats or with searchMessagesFilterFailedToSend filter without an enabled message database.

Returns object_ptr<MessagePositions>.

Definition at line 103811 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

using td::td_api::getChatSparseMessagePositions::ReturnType = object_ptr<messagePositions>

Typedef for the type returned by the function.

Definition at line 103856 of file td_api.h.

Constructor & Destructor Documentation

◆ getChatSparseMessagePositions() [1/2]

td::td_api::getChatSparseMessagePositions::getChatSparseMessagePositions ( )

Default constructor for a function, which returns sparse positions of messages of the specified type in the chat to be used for shared media scroll implementation. Returns the results in reverse chronological order (i.e., in order of decreasing message_id). Cannot be used in secret chats or with searchMessagesFilterFailedToSend filter without an enabled message database.

Returns object_ptr<MessagePositions>.

◆ getChatSparseMessagePositions() [2/2]

td::td_api::getChatSparseMessagePositions::getChatSparseMessagePositions ( int53  chat_id_,
object_ptr< SearchMessagesFilter > &&  filter_,
int53  from_message_id_,
int32  limit_,
int53  saved_messages_topic_id_ 
)

Creates a function, which returns sparse positions of messages of the specified type in the chat to be used for shared media scroll implementation. Returns the results in reverse chronological order (i.e., in order of decreasing message_id). Cannot be used in secret chats or with searchMessagesFilterFailedToSend filter without an enabled message database.

Returns object_ptr<MessagePositions>.

Parameters
[in]chat_id_Identifier of the chat in which to return information about message positions.
[in]filter_Filter for message content. Filters searchMessagesFilterEmpty, searchMessagesFilterMention, searchMessagesFilterUnreadMention, searchMessagesFilterUnreadReaction, and searchMessagesFilterUnreadPollVote are unsupported in this function.
[in]from_message_id_The message identifier from which to return information about message positions.
[in]limit_The expected number of message positions to be returned; 50-2000. A smaller number of positions can be returned, if there are not enough appropriate messages.
[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, or for chats other than Saved Messages.

Member Function Documentation

◆ store()

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

◆ chat_id_

int53 td::td_api::getChatSparseMessagePositions::chat_id_

Identifier of the chat in which to return information about message positions.

Definition at line 103822 of file td_api.h.

◆ filter_

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

Filter for message content. Filters searchMessagesFilterEmpty, searchMessagesFilterMention, searchMessagesFilterUnreadMention, searchMessagesFilterUnreadReaction, and searchMessagesFilterUnreadPollVote are unsupported in this function.

Definition at line 103824 of file td_api.h.

◆ from_message_id_

int53 td::td_api::getChatSparseMessagePositions::from_message_id_

The message identifier from which to return information about message positions.

Definition at line 103826 of file td_api.h.

◆ ID

const std::int32_t td::td_api::getChatSparseMessagePositions::ID = 994389757
static

Identifier uniquely determining a type of the object.

Definition at line 103853 of file td_api.h.

◆ limit_

int32 td::td_api::getChatSparseMessagePositions::limit_

The expected number of message positions to be returned; 50-2000. A smaller number of positions can be returned, if there are not enough appropriate messages.

Definition at line 103828 of file td_api.h.

◆ saved_messages_topic_id_

int53 td::td_api::getChatSparseMessagePositions::saved_messages_topic_id_

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

Definition at line 103830 of file td_api.h.

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