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

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

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

Public Types

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

Public Member Functions

 getChatArchivedStories ()
 
 getChatArchivedStories (int53 chat_id_, int32 from_story_id_, 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 from_story_id_
 Identifier of the story starting from which stories must be returned; use 0 to get results from the last story.
 
int32 limit_
 The maximum number of stories to be returned. For optimal performance, the number of returned stories is chosen by TDLib and can be smaller than the specified limit.
 

Static Public Attributes

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

Detailed Description

Returns the list of all stories posted by the given chat; requires can_edit_stories administrator right in the chat. The stories are returned in reverse chronological order (i.e., in order of decreasing story_id). For optimal performance, the number of returned stories is chosen by TDLib.

Returns object_ptr<Stories>.

Definition at line 101739 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 101778 of file td_api.h.

Constructor & Destructor Documentation

◆ getChatArchivedStories() [1/2]

td::td_api::getChatArchivedStories::getChatArchivedStories ( )

Default constructor for a function, which returns the list of all stories posted by the given chat; requires can_edit_stories administrator right in the chat. The stories are returned in reverse chronological order (i.e., in order of decreasing story_id). For optimal performance, the number of returned stories is chosen by TDLib.

Returns object_ptr<Stories>.

◆ getChatArchivedStories() [2/2]

td::td_api::getChatArchivedStories::getChatArchivedStories ( int53  chat_id_,
int32  from_story_id_,
int32  limit_ 
)

Creates a function, which returns the list of all stories posted by the given chat; requires can_edit_stories administrator right in the chat. The stories are returned in reverse chronological order (i.e., in order of decreasing story_id). For optimal performance, the number of returned stories is chosen by TDLib.

Returns object_ptr<Stories>.

Parameters
[in]chat_id_Chat identifier.
[in]from_story_id_Identifier of the story starting from which stories must be returned; use 0 to get results from the last story.
[in]limit_The maximum number of stories to be returned. For optimal performance, the number of returned stories is chosen by TDLib and can be smaller than the specified limit.

Member Function Documentation

◆ store()

void td::td_api::getChatArchivedStories::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::getChatArchivedStories::chat_id_

Chat identifier.

Definition at line 101750 of file td_api.h.

◆ from_story_id_

int32 td::td_api::getChatArchivedStories::from_story_id_

Identifier of the story starting from which stories must be returned; use 0 to get results from the last story.

Definition at line 101752 of file td_api.h.

◆ ID

const std::int32_t td::td_api::getChatArchivedStories::ID = -1356950392
static

Identifier uniquely determining a type of the object.

Definition at line 101775 of file td_api.h.

◆ limit_

int32 td::td_api::getChatArchivedStories::limit_

The maximum number of stories to be returned. For optimal performance, the number of returned stories is chosen by TDLib and can be smaller than the specified limit.

Definition at line 101754 of file td_api.h.


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