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

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

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

Public Types

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

Public Member Functions

 loadChats ()
 
 loadChats (object_ptr< ChatList > &&chat_list_, 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

object_ptr< ChatListchat_list_
 The chat list in which to load chats; pass null to load chats from the main chat list.
 
int32 limit_
 The maximum number of chats to be loaded. For optimal performance, the number of loaded chats is chosen by TDLib and can be smaller than the specified limit, even if the end of the list is not reached.
 

Static Public Attributes

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

Detailed Description

Loads more chats from a chat list for incremental chat list synchronization. The loaded chats and their positions in the chat list will be sent through updates. Chats are sorted by the pair (chat.position.order, chat.id) in descending order. Returns a 404 error if all chats have been loaded.

Returns object_ptr<Ok>.

Definition at line 116985 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 117021 of file td_api.h.

Constructor & Destructor Documentation

◆ loadChats() [1/2]

td::td_api::loadChats::loadChats ( )

Default constructor for a function, which loads more chats from a chat list for incremental chat list synchronization. The loaded chats and their positions in the chat list will be sent through updates. Chats are sorted by the pair (chat.position.order, chat.id) in descending order. Returns a 404 error if all chats have been loaded.

Returns object_ptr<Ok>.

◆ loadChats() [2/2]

td::td_api::loadChats::loadChats ( object_ptr< ChatList > &&  chat_list_,
int32  limit_ 
)

Creates a function, which loads more chats from a chat list for incremental chat list synchronization. The loaded chats and their positions in the chat list will be sent through updates. Chats are sorted by the pair (chat.position.order, chat.id) in descending order. Returns a 404 error if all chats have been loaded.

Returns object_ptr<Ok>.

Parameters
[in]chat_list_The chat list in which to load chats; pass null to load chats from the main chat list.
[in]limit_The maximum number of chats to be loaded. For optimal performance, the number of loaded chats is chosen by TDLib and can be smaller than the specified limit, even if the end of the list is not reached.

Member Function Documentation

◆ store()

void td::td_api::loadChats::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_list_

object_ptr<ChatList> td::td_api::loadChats::chat_list_

The chat list in which to load chats; pass null to load chats from the main chat list.

Definition at line 116996 of file td_api.h.

◆ ID

const std::int32_t td::td_api::loadChats::ID = -1885635205
static

Identifier uniquely determining a type of the object.

Definition at line 117018 of file td_api.h.

◆ limit_

int32 td::td_api::loadChats::limit_

The maximum number of chats to be loaded. For optimal performance, the number of loaded chats is chosen by TDLib and can be smaller than the specified limit, even if the end of the list is not reached.

Definition at line 116998 of file td_api.h.


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