TDLib
Loading...
Searching...
No Matches
td::td_api::sendStory Class Referencefinal

Inherits td::td_api::Function.

Public Types

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

Public Member Functions

 sendStory ()
 
 sendStory (int53 chat_id_, object_ptr< InputStoryContent > &&content_, object_ptr< inputStoryAreas > &&areas_, object_ptr< formattedText > &&caption_, object_ptr< StoryPrivacySettings > &&privacy_settings_, int32 active_period_, bool is_pinned_, bool protect_content_)
 
std::int32_t get_id () const final
 
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 chat_id_
 Identifier of the chat that will post the story.
 
object_ptr< InputStoryContentcontent_
 Content of the story.
 
object_ptr< inputStoryAreasareas_
 Clickable rectangle areas to be shown on the story media; pass null if none.
 
object_ptr< formattedTextcaption_
 Story caption; pass null to use an empty caption; 0-getOption("story_caption_length_max") characters.
 
object_ptr< StoryPrivacySettingsprivacy_settings_
 The privacy settings for the story.
 
int32 active_period_
 Period after which the story is moved to archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400 for Telegram Premium users, and 86400 otherwise.
 
bool is_pinned_
 Pass true to keep the story accessible after expiration.
 
bool protect_content_
 Pass true if the content of the story must be protected from forwarding and screenshotting.
 

Static Public Attributes

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

Detailed Description

Sends a new story to a chat; requires can_post_stories rights for channel chats. Returns a temporary story.

Returns object_ptr<Story>.

Constructor & Destructor Documentation

◆ sendStory() [1/2]

td::td_api::sendStory::sendStory ( )

Default constructor for a function, which sends a new story to a chat; requires can_post_stories rights for channel chats. Returns a temporary story.

Returns object_ptr<Story>.

◆ sendStory() [2/2]

td::td_api::sendStory::sendStory ( int53  chat_id_,
object_ptr< InputStoryContent > &&  content_,
object_ptr< inputStoryAreas > &&  areas_,
object_ptr< formattedText > &&  caption_,
object_ptr< StoryPrivacySettings > &&  privacy_settings_,
int32  active_period_,
bool  is_pinned_,
bool  protect_content_ 
)

Creates a function, which sends a new story to a chat; requires can_post_stories rights for channel chats. Returns a temporary story.

Returns object_ptr<Story>.

Parameters
[in]chat_id_Identifier of the chat that will post the story.
[in]content_Content of the story.
[in]areas_Clickable rectangle areas to be shown on the story media; pass null if none.
[in]caption_Story caption; pass null to use an empty caption; 0-getOption("story_caption_length_max") characters.
[in]privacy_settings_The privacy settings for the story.
[in]active_period_Period after which the story is moved to archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400 for Telegram Premium users, and 86400 otherwise.
[in]is_pinned_Pass true to keep the story accessible after expiration.
[in]protect_content_Pass true if the content of the story must be protected from forwarding and screenshotting.

Member Function Documentation

◆ get_id()

std::int32_t td::td_api::sendStory::get_id ( ) const
inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns
this->ID.

Implements td::TlObject.

◆ store()

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


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