TDLib
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
getStoryAlbumStories Class Referencefinal

Inherits Function.

Description

Returns the list of stories added to the given story album. For optimal performance, the number of returned stories is chosen by TDLib.

Returns object_ptr<Stories>.

Public Types

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

Public Member Functions

 getStoryAlbumStories ()
 
 getStoryAlbumStories (int53 chat_id_, int32 story_album_id_, int32 offset_, int32 limit_)
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Member Functions inherited from TlObject
TlObject & operator= (const TlObject &)=delete
 
TlObject & operator= (TlObject &&)=default
 
virtual void store (TlStorerCalcLength &s) const
 
virtual void store (TlStorerUnsafe &s) const
 
 TlObject ()=default
 
 TlObject (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Public Attributes

int53 chat_id_
 Chat identifier.
 
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.
 
int32 offset_
 Offset of the first entry to return; use 0 to get results from the first album story.
 
int32 story_album_id_
 Story album identifier.
 

Static Public Attributes

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

Constructor & Destructor Documentation

◆ getStoryAlbumStories() [1/2]

Default constructor for a function, which returns the list of stories added to the given story album. For optimal performance, the number of returned stories is chosen by TDLib.

Returns object_ptr<Stories>.

◆ getStoryAlbumStories() [2/2]

getStoryAlbumStories ( int53  chat_id_,
int32  story_album_id_,
int32  offset_,
int32  limit_ 
)

Creates a function, which returns the list of stories added to the given story album. For optimal performance, the number of returned stories is chosen by TDLib.

Returns object_ptr<Stories>.

Parameters
[in]chat_id_Chat identifier.
[in]story_album_id_Story album identifier.
[in]offset_Offset of the first entry to return; use 0 to get results from the first album 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 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 TlObject.


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