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

Inherits Function.

Description

Changes name of an album of stories. If the album is owned by a supergroup or a channel chat, then requires can_edit_stories administrator right in the chat. Returns the changed album.

Returns object_ptr<StoryAlbum>.

Public Types

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

Public Member Functions

 setStoryAlbumName ()
 setStoryAlbumName (int53 chat_id_, int32 story_album_id_, string const &name_)
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_
 Identifier of the chat that owns the stories.
string name_
 New name of the album; 1-12 characters.
int32 story_album_id_
 Identifier of the story album.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ setStoryAlbumName() [1/2]

setStoryAlbumName ( )

Default constructor for a function, which changes name of an album of stories. If the album is owned by a supergroup or a channel chat, then requires can_edit_stories administrator right in the chat. Returns the changed album.

Returns object_ptr<StoryAlbum>.

◆ setStoryAlbumName() [2/2]

setStoryAlbumName ( int53 chat_id_,
int32 story_album_id_,
string const & name_ )

Creates a function, which changes name of an album of stories. If the album is owned by a supergroup or a channel chat, then requires can_edit_stories administrator right in the chat. Returns the changed album.

Returns object_ptr<StoryAlbum>.

Parameters
[in]chat_id_Identifier of the chat that owns the stories.
[in]story_album_id_Identifier of the story album.
[in]name_New name of the album; 1-12 characters.

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: