TDLib
Loading...
Searching...
No Matches
getSavedMessagesTopicHistory Class Referencefinal

Inherits Function.

Description

Returns messages in a Saved Messages topic. The messages are returned in reverse chronological order (i.e., in order of decreasing message_id).

Returns object_ptr<Messages>.

Public Types

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

Public Member Functions

 getSavedMessagesTopicHistory ()
 getSavedMessagesTopicHistory (int53 saved_messages_topic_id_, int53 from_message_id_, int32 offset_, int32 limit_)
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 from_message_id_
 Identifier of the message starting from which messages 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 or equal to -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 from -99 to -1 to get additionally -offset newer messages.
int53 saved_messages_topic_id_
 Identifier of Saved Messages topic which messages will be fetched.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ getSavedMessagesTopicHistory() [1/2]

getSavedMessagesTopicHistory ( )

Default constructor for a function, which returns messages in a Saved Messages topic. The messages are returned in reverse chronological order (i.e., in order of decreasing message_id).

Returns object_ptr<Messages>.

◆ getSavedMessagesTopicHistory() [2/2]

getSavedMessagesTopicHistory ( int53 saved_messages_topic_id_,
int53 from_message_id_,
int32 offset_,
int32 limit_ )

Creates a function, which returns messages in a Saved Messages topic. The messages are returned in reverse chronological order (i.e., in order of decreasing message_id).

Returns object_ptr<Messages>.

Parameters
[in]saved_messages_topic_id_Identifier of Saved Messages topic which messages will be fetched.
[in]from_message_id_Identifier of the message starting from which messages 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 from -99 to -1 to get additionally -offset 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 or equal to -offset. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit.

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]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: