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

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

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

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 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 story_poster_chat_id_
 Identifier of the chat that posted the story.
 
int32 story_id_
 Identifier of the story to edit.
 
object_ptr< InputStoryContentcontent_
 New content of the story; pass null to keep the current content.
 
object_ptr< inputStoryAreasareas_
 New clickable rectangle areas to be shown on the story media; pass null to keep the current areas. Areas can&#x27;t be edited if story content isn&#x27;t changed.
 
object_ptr< formattedTextcaption_
 New story caption; pass null to keep the current caption.
 

Static Public Attributes

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

Detailed Description

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

Returns object_ptr<Ok>.

Definition at line 99152 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 99197 of file td_api.h.

Constructor & Destructor Documentation

◆ editStory() [1/2]

td::td_api::editStory::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]

td::td_api::editStory::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&#x27;t be edited if story content isn&#x27;t changed.
[in]caption_New story caption; pass null to keep the current caption.

Member Function Documentation

◆ store()

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

◆ areas_

object_ptr<inputStoryAreas> td::td_api::editStory::areas_

New clickable rectangle areas to be shown on the story media; pass null to keep the current areas. Areas can&#x27;t be edited if story content isn&#x27;t changed.

Definition at line 99169 of file td_api.h.

◆ caption_

object_ptr<formattedText> td::td_api::editStory::caption_

New story caption; pass null to keep the current caption.

Definition at line 99171 of file td_api.h.

◆ content_

object_ptr<InputStoryContent> td::td_api::editStory::content_

New content of the story; pass null to keep the current content.

Definition at line 99167 of file td_api.h.

◆ ID

const std::int32_t td::td_api::editStory::ID = 355296788
static

Identifier uniquely determining a type of the object.

Definition at line 99194 of file td_api.h.

◆ story_id_

int32 td::td_api::editStory::story_id_

Identifier of the story to edit.

Definition at line 99165 of file td_api.h.

◆ story_poster_chat_id_

int53 td::td_api::editStory::story_poster_chat_id_

Identifier of the chat that posted the story.

Definition at line 99163 of file td_api.h.


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