td::td_api::getChatHistory Class Reference

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

Inheritance diagram for td::td_api::getChatHistory:

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

Public Member Functions
	getChatHistory ()
	getChatHistory (int53 chat_id_, int53 from_message_id_, int32 offset_, int32 limit_, bool only_local_)
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_
	Chat 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'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.
bool	only_local_
	Pass true to get only messages that are available without sending network requests.

Static Public Attributes
static const std::int32_t	ID = -799960451
	Identifier uniquely determining a type of the object.

Detailed Description

Returns messages in a chat. 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. This is an offline method if only_local is true.

Returns object_ptr<Messages>.

Definition at line 102578 of file td_api.h.

Member Typedef Documentation

ReturnType

using td::td_api::getChatHistory::ReturnType = object_ptr<messages>

Typedef for the type returned by the function.

Definition at line 102623 of file td_api.h.

Constructor & Destructor Documentation

getChatHistory() [1/2]

td::td_api::getChatHistory::getChatHistory

(

)

Default constructor for a function, which returns messages in a chat. 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. This is an offline method if only_local is true.

Returns object_ptr<Messages>.

getChatHistory() [2/2]

td::td_api::getChatHistory::getChatHistory	(	int53	chat_id_,
		int53	from_message_id_,
		int32	offset_,
		int32	limit_,
		bool	only_local_
	)

Creates a function, which returns messages in a chat. 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. This is an offline method if only_local is true.

Returns object_ptr<Messages>.

Parameters

[in]	chat_id_	Chat 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'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.
[in]	only_local_	Pass true to get only messages that are available without sending network requests.

Member Function Documentation

store()

void td::td_api::getChatHistory::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]	s	Storer to which object string representation will be appended.
[in]	field_name	Object field_name if applicable.

Implements td::TlObject.

Member Data Documentation

chat_id_

int53 td::td_api::getChatHistory::chat_id_

Chat identifier.

Definition at line 102589 of file td_api.h.

from_message_id_

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

ID

const std::int32_t td::td_api::getChatHistory::ID = -799960451

static

Identifier uniquely determining a type of the object.

Definition at line 102620 of file td_api.h.

limit_

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

offset_

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

only_local_

bool td::td_api::getChatHistory::only_local_

Pass true to get only messages that are available without sending network requests.

Definition at line 102597 of file td_api.h.

---

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

• /home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h