TDLib
Loading...
Searching...
No Matches
createStoryAlbum Class Referencefinal

Inherits Function.

Description

Creates an album of stories; requires can_edit_stories administrator right for supergroup and channel chats.

Returns object_ptr<StoryAlbum>.

Public Types

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

Public Member Functions

 createStoryAlbum ()
 createStoryAlbum (int53 story_poster_chat_id_, string const &name_, array< int32 > &&story_ids_)
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

string name_
 Name of the album; 1-12 characters.
array< int32 > story_ids_
 Identifiers of stories to add to the album; 0-getOption("story_album_size_max") identifiers.
int53 story_poster_chat_id_
 Identifier of the chat that posted the stories.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ createStoryAlbum() [1/2]

createStoryAlbum ( )

Default constructor for a function, which creates an album of stories; requires can_edit_stories administrator right for supergroup and channel chats.

Returns object_ptr<StoryAlbum>.

◆ createStoryAlbum() [2/2]

createStoryAlbum ( int53 story_poster_chat_id_,
string const & name_,
array< int32 > && story_ids_ )

Creates a function, which creates an album of stories; requires can_edit_stories administrator right for supergroup and channel chats.

Returns object_ptr<StoryAlbum>.

Parameters
[in]story_poster_chat_id_Identifier of the chat that posted the stories.
[in]name_Name of the album; 1-12 characters.
[in]story_ids_Identifiers of stories to add to the album; 0-getOption("story_album_size_max") identifiers.

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: