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::getMessageThreadHistory Class Referencefinal

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

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

Public Types

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

Public Member Functions

 getMessageThreadHistory ()
 
 getMessageThreadHistory (int53 chat_id_, int53 message_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.
 
int53 message_id_
 Message identifier, which thread history needs to be returned.
 
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 = -1808411608
 Identifier uniquely determining a type of the object.
 

Detailed Description

Returns messages in a message thread of a message. Can be used only if messageProperties.can_get_message_thread == true. Message thread of a channel message is in the channel&#x27;s linked supergroup. 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 109567 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 109612 of file td_api.h.

Constructor & Destructor Documentation

◆ getMessageThreadHistory() [1/2]

td::td_api::getMessageThreadHistory::getMessageThreadHistory ( )

Default constructor for a function, which returns messages in a message thread of a message. Can be used only if messageProperties.can_get_message_thread == true. Message thread of a channel message is in the channel&#x27;s linked supergroup. 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>.

◆ getMessageThreadHistory() [2/2]

td::td_api::getMessageThreadHistory::getMessageThreadHistory ( int53  chat_id_,
int53  message_id_,
int53  from_message_id_,
int32  offset_,
int32  limit_ 
)

Creates a function, which returns messages in a message thread of a message. Can be used only if messageProperties.can_get_message_thread == true. Message thread of a channel message is in the channel&#x27;s linked supergroup. 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]message_id_Message identifier, which thread history needs to be returned.
[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::getMessageThreadHistory::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::getMessageThreadHistory::chat_id_

Chat identifier.

Definition at line 109578 of file td_api.h.

◆ from_message_id_

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

◆ ID

const std::int32_t td::td_api::getMessageThreadHistory::ID = -1808411608
static

Identifier uniquely determining a type of the object.

Definition at line 109609 of file td_api.h.

◆ limit_

int32 td::td_api::getMessageThreadHistory::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 109586 of file td_api.h.

◆ message_id_

int53 td::td_api::getMessageThreadHistory::message_id_

Message identifier, which thread history needs to be returned.

Definition at line 109580 of file td_api.h.

◆ offset_

int32 td::td_api::getMessageThreadHistory::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 109584 of file td_api.h.


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