List of all members | Public Fields | Public Types | Public Instance Methods | Static Public Attributes
getChatSparseMessagePositions Class Referencefinal

Inherits Function.

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

Public Fields

int53 chat_id_
 Identifier of the chat in which to return information about message positions.
 
object_ptr< SearchMessagesFilterfilter_
 Filter for message content. Filters searchMessagesFilterEmpty, searchMessagesFilterMention, searchMessagesFilterUnreadMention, and searchMessagesFilterUnreadReaction 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.
 

Public Types

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

Public Instance Methods

 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 Instance Methods inherited from TlObject
virtual void store (TlStorerUnsafe &s) const
 
virtual void store (TlStorerCalcLength &s) const
 
 TlObject ()=default
 
 TlObject (const TlObject &)=delete
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Static Public Attributes

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

Constructor & Destructor Documentation

◆ getChatSparseMessagePositions() [1/2]

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]

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, and searchMessagesFilterUnreadReaction 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.

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]sStorer to which object string representation will be appended.
[in]field_nameObject field_name if applicable.

Implements TlObject.


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