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

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

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

Public Types

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

Public Member Functions

 postStory ()
 
 postStory (int53 chat_id_, object_ptr< InputStoryContent > &&content_, object_ptr< inputStoryAreas > &&areas_, object_ptr< formattedText > &&caption_, object_ptr< StoryPrivacySettings > &&privacy_settings_, array< int32 > &&album_ids_, int32 active_period_, object_ptr< storyFullId > &&from_story_full_id_, bool is_posted_to_chat_page_, bool protect_content_)
 
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. Pass Saved Messages chat identifier when posting a story on behalf of the current user.
 
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; can have entities only if getOption("can_use_text_entities_in_story_caption").
 
object_ptr< StoryPrivacySettingsprivacy_settings_
 The privacy settings for the story; ignored for stories posted on behalf of supergroup and channel chats.
 
array< int32album_ids_
 Identifiers of story albums to which the story will be added upon posting. An album can have up to getOption("story_album_size_max") stories.
 
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.
 
object_ptr< storyFullIdfrom_story_full_id_
 Full identifier of the original story, which content was used to create the story; pass null if the story isn&#x27;t repost of another story.
 
bool is_posted_to_chat_page_
 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 = -1725643742
 Identifier uniquely determining a type of the object.
 

Detailed Description

Posts a new story on behalf of a chat; requires can_post_stories administrator right for supergroup and channel chats. Returns a temporary story.

Returns object_ptr<Story>.

Definition at line 118180 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 118240 of file td_api.h.

Constructor & Destructor Documentation

◆ postStory() [1/2]

td::td_api::postStory::postStory ( )

Default constructor for a function, which posts a new story on behalf of a chat; requires can_post_stories administrator right for supergroup and channel chats. Returns a temporary story.

Returns object_ptr<Story>.

◆ postStory() [2/2]

td::td_api::postStory::postStory ( int53  chat_id_,
object_ptr< InputStoryContent > &&  content_,
object_ptr< inputStoryAreas > &&  areas_,
object_ptr< formattedText > &&  caption_,
object_ptr< StoryPrivacySettings > &&  privacy_settings_,
array< int32 > &&  album_ids_,
int32  active_period_,
object_ptr< storyFullId > &&  from_story_full_id_,
bool  is_posted_to_chat_page_,
bool  protect_content_ 
)

Creates a function, which posts a new story on behalf of a chat; requires can_post_stories administrator right for supergroup and channel chats. Returns a temporary story.

Returns object_ptr<Story>.

Parameters
[in]chat_id_Identifier of the chat that will post the story. Pass Saved Messages chat identifier when posting a story on behalf of the current user.
[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; can have entities only if getOption("can_use_text_entities_in_story_caption").
[in]privacy_settings_The privacy settings for the story; ignored for stories posted on behalf of supergroup and channel chats.
[in]album_ids_Identifiers of story albums to which the story will be added upon posting. An album can have up to getOption("story_album_size_max") stories.
[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]from_story_full_id_Full identifier of the original story, which content was used to create the story; pass null if the story isn&#x27;t repost of another story.
[in]is_posted_to_chat_page_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

◆ store()

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

◆ active_period_

int32 td::td_api::postStory::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.

Definition at line 118203 of file td_api.h.

◆ album_ids_

array<int32> td::td_api::postStory::album_ids_

Identifiers of story albums to which the story will be added upon posting. An album can have up to getOption("story_album_size_max") stories.

Definition at line 118201 of file td_api.h.

◆ areas_

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

Clickable rectangle areas to be shown on the story media; pass null if none.

Definition at line 118195 of file td_api.h.

◆ caption_

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

Story caption; pass null to use an empty caption; 0-getOption("story_caption_length_max") characters; can have entities only if getOption("can_use_text_entities_in_story_caption").

Definition at line 118197 of file td_api.h.

◆ chat_id_

int53 td::td_api::postStory::chat_id_

Identifier of the chat that will post the story. Pass Saved Messages chat identifier when posting a story on behalf of the current user.

Definition at line 118191 of file td_api.h.

◆ content_

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

Content of the story.

Definition at line 118193 of file td_api.h.

◆ from_story_full_id_

object_ptr<storyFullId> td::td_api::postStory::from_story_full_id_

Full identifier of the original story, which content was used to create the story; pass null if the story isn&#x27;t repost of another story.

Definition at line 118205 of file td_api.h.

◆ ID

const std::int32_t td::td_api::postStory::ID = -1725643742
static

Identifier uniquely determining a type of the object.

Definition at line 118237 of file td_api.h.

◆ is_posted_to_chat_page_

bool td::td_api::postStory::is_posted_to_chat_page_

Pass true to keep the story accessible after expiration.

Definition at line 118207 of file td_api.h.

◆ privacy_settings_

object_ptr<StoryPrivacySettings> td::td_api::postStory::privacy_settings_

The privacy settings for the story; ignored for stories posted on behalf of supergroup and channel chats.

Definition at line 118199 of file td_api.h.

◆ protect_content_

bool td::td_api::postStory::protect_content_

Pass true if the content of the story must be protected from forwarding and screenshotting.

Definition at line 118209 of file td_api.h.


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