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

Inherits Function.

Description

Changes content and caption of a story. Can be called only if story.can_be_edited == true.

Returns object_ptr<Ok>.

Public Types

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

Public Member Functions

 editStory ()
 editStory (int53 story_poster_chat_id_, int32 story_id_, object_ptr< InputStoryContent > &&content_, object_ptr< inputStoryAreas > &&areas_, object_ptr< formattedText > &&caption_)
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

object_ptr< inputStoryAreas > areas_
 New clickable rectangle areas to be shown on the story media; pass null to keep the current areas. Areas can't be edited if story content isn't changed.
object_ptr< formattedText > caption_
 New story caption; pass null to keep the current caption.
object_ptr< InputStoryContent > content_
 New content of the story; pass null to keep the current content.
int32 story_id_
 Identifier of the story to edit.
int53 story_poster_chat_id_
 Identifier of the chat that posted the story.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ editStory() [1/2]

editStory ( )

Default constructor for a function, which changes content and caption of a story. Can be called only if story.can_be_edited == true.

Returns object_ptr<Ok>.

◆ editStory() [2/2]

editStory ( int53 story_poster_chat_id_,
int32 story_id_,
object_ptr< InputStoryContent > && content_,
object_ptr< inputStoryAreas > && areas_,
object_ptr< formattedText > && caption_ )

Creates a function, which changes content and caption of a story. Can be called only if story.can_be_edited == true.

Returns object_ptr<Ok>.

Parameters
[in]story_poster_chat_id_Identifier of the chat that posted the story.
[in]story_id_Identifier of the story to edit.
[in]content_New content of the story; pass null to keep the current content.
[in]areas_New clickable rectangle areas to be shown on the story media; pass null to keep the current areas. Areas can't be edited if story content isn't changed.
[in]caption_New story caption; pass null to keep the current caption.

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: