tdlib-obf API
Reference documentation for the public tdlib-obf API, generated from TDLib schemas and public headers
Loading...
Searching...
No Matches
td::td_api::getForumTopicHistory Class Referencefinal

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

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

Public Types

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

Public Member Functions

 getForumTopicHistory ()
 
 getForumTopicHistory (int53 chat_id_, int32 forum_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 td::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
 

Public Attributes

int53 chat_id_
 Chat identifier.
 
int32 forum_topic_id_
 Forum topic identifier.
 
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 from -99 to -1 to get additionally -offset newer messages.
 
int32 limit_
 The maximum number of messages to be returned; must be positive and can&#x27;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.
 

Static Public Attributes

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

Detailed Description

Returns messages in a topic in a forum supergroup chat or a chat with a bot with topics. The messages are returned in reverse chronological order (i.e., in order of decreasing message_id). For optimal performance, the number of returned messages is chosen by TDLib.

Returns object_ptr<Messages>.

Definition at line 106109 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 106154 of file td_api.h.

Constructor & Destructor Documentation

◆ getForumTopicHistory() [1/2]

td::td_api::getForumTopicHistory::getForumTopicHistory ( )

Default constructor for a function, which returns messages in a topic in a forum supergroup chat or a chat with a bot with topics. The messages are returned in reverse chronological order (i.e., in order of decreasing message_id). For optimal performance, the number of returned messages is chosen by TDLib.

Returns object_ptr<Messages>.

◆ getForumTopicHistory() [2/2]

td::td_api::getForumTopicHistory::getForumTopicHistory ( int53  chat_id_,
int32  forum_topic_id_,
int53  from_message_id_,
int32  offset_,
int32  limit_ 
)

Creates a function, which returns messages in a topic in a forum supergroup chat or a chat with a bot with topics. The messages are returned in reverse chronological order (i.e., in order of decreasing message_id). For optimal performance, the number of returned messages is chosen by TDLib.

Returns object_ptr<Messages>.

Parameters
[in]chat_id_Chat identifier.
[in]forum_topic_id_Forum topic identifier.
[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 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&#x27;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 td::td_api::getForumTopicHistory::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::getForumTopicHistory::chat_id_

Chat identifier.

Definition at line 106120 of file td_api.h.

◆ forum_topic_id_

int32 td::td_api::getForumTopicHistory::forum_topic_id_

Forum topic identifier.

Definition at line 106122 of file td_api.h.

◆ from_message_id_

int53 td::td_api::getForumTopicHistory::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 106124 of file td_api.h.

◆ ID

const std::int32_t td::td_api::getForumTopicHistory::ID = -339129791
static

Identifier uniquely determining a type of the object.

Definition at line 106151 of file td_api.h.

◆ limit_

int32 td::td_api::getForumTopicHistory::limit_

The maximum number of messages to be returned; must be positive and can&#x27;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.

Definition at line 106128 of file td_api.h.

◆ offset_

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

Definition at line 106126 of file td_api.h.


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