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

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

Inheritance diagram for td::td_api::story:
td::td_api::Object td::TlObject

Public Member Functions

 story ()
 
 story (int32 id_, int53 poster_chat_id_, object_ptr< MessageSender > &&poster_id_, int32 date_, bool is_being_posted_, bool is_being_edited_, bool is_edited_, bool is_posted_to_chat_page_, bool is_visible_only_for_self_, bool can_be_added_to_album_, bool can_be_deleted_, bool can_be_edited_, bool can_be_forwarded_, bool can_be_replied_, bool can_set_privacy_settings_, bool can_toggle_is_posted_to_chat_page_, bool can_get_statistics_, bool can_get_interactions_, bool has_expired_viewers_, object_ptr< storyRepostInfo > &&repost_info_, object_ptr< storyInteractionInfo > &&interaction_info_, object_ptr< ReactionType > &&chosen_reaction_type_, object_ptr< StoryPrivacySettings > &&privacy_settings_, object_ptr< StoryContent > &&content_, array< object_ptr< storyArea > > &&areas_, object_ptr< formattedText > &&caption_, array< int32 > &&album_ids_)
 
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

int32 id_
 Unique story identifier among stories posted by the given chat.
 
int53 poster_chat_id_
 Identifier of the chat that posted the story.
 
object_ptr< MessageSenderposter_id_
 Identifier of the user or chat that posted the story; may be null if the story is posted on behalf of the poster_chat_id.
 
int32 date_
 Point in time (Unix timestamp) when the story was published.
 
bool is_being_posted_
 True, if the story is being posted by the current user.
 
bool is_being_edited_
 True, if the story is being edited by the current user.
 
bool is_edited_
 True, if the story was edited.
 
bool is_posted_to_chat_page_
 True, if the story is saved in the profile of the chat that posted it and will be available there after expiration.
 
bool is_visible_only_for_self_
 True, if the story is visible only for the current user.
 
bool can_be_added_to_album_
 True, if the story can be added to an album using createStoryAlbum and addStoryAlbumStories.
 
bool can_be_deleted_
 True, if the story can be deleted.
 
bool can_be_edited_
 True, if the story can be edited.
 
bool can_be_forwarded_
 True, if the story can be forwarded as a message or reposted as a story. Otherwise, screenshotting and saving of the story content must be also forbidden.
 
bool can_be_replied_
 True, if the story can be replied in the chat with the user who posted the story.
 
bool can_set_privacy_settings_
 True, if the story privacy settings can be changed.
 
bool can_toggle_is_posted_to_chat_page_
 True, if the story&#x27;s is_posted_to_chat_page value can be changed.
 
bool can_get_statistics_
 True, if the story statistics are available through getStoryStatistics.
 
bool can_get_interactions_
 True, if interactions with the story can be received through getStoryInteractions.
 
bool has_expired_viewers_
 True, if users viewed the story can&#x27;t be received, because the story has expired more than getOption("story_viewers_expiration_delay") seconds ago.
 
object_ptr< storyRepostInforepost_info_
 Information about the original story; may be null if the story wasn&#x27;t reposted.
 
object_ptr< storyInteractionInfointeraction_info_
 Information about interactions with the story; may be null if the story isn&#x27;t owned or there were no interactions.
 
object_ptr< ReactionTypechosen_reaction_type_
 Type of the chosen reaction; may be null if none.
 
object_ptr< StoryPrivacySettingsprivacy_settings_
 Privacy rules affecting story visibility; may be approximate for non-owned stories.
 
object_ptr< StoryContentcontent_
 Content of the story.
 
array< object_ptr< storyArea > > areas_
 Clickable areas to be shown on the story content.
 
object_ptr< formattedTextcaption_
 Caption of the story.
 
array< int32album_ids_
 Identifiers of story albums to which the story is added; only for manageable stories.
 

Static Public Attributes

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

Detailed Description

Represents a story.

Definition at line 68547 of file td_api.h.

Constructor & Destructor Documentation

◆ story() [1/2]

td::td_api::story::story ( )

Represents a story.

◆ story() [2/2]

td::td_api::story::story ( int32  id_,
int53  poster_chat_id_,
object_ptr< MessageSender > &&  poster_id_,
int32  date_,
bool  is_being_posted_,
bool  is_being_edited_,
bool  is_edited_,
bool  is_posted_to_chat_page_,
bool  is_visible_only_for_self_,
bool  can_be_added_to_album_,
bool  can_be_deleted_,
bool  can_be_edited_,
bool  can_be_forwarded_,
bool  can_be_replied_,
bool  can_set_privacy_settings_,
bool  can_toggle_is_posted_to_chat_page_,
bool  can_get_statistics_,
bool  can_get_interactions_,
bool  has_expired_viewers_,
object_ptr< storyRepostInfo > &&  repost_info_,
object_ptr< storyInteractionInfo > &&  interaction_info_,
object_ptr< ReactionType > &&  chosen_reaction_type_,
object_ptr< StoryPrivacySettings > &&  privacy_settings_,
object_ptr< StoryContent > &&  content_,
array< object_ptr< storyArea > > &&  areas_,
object_ptr< formattedText > &&  caption_,
array< int32 > &&  album_ids_ 
)

Represents a story.

Parameters
[in]id_Unique story identifier among stories posted by the given chat.
[in]poster_chat_id_Identifier of the chat that posted the story.
[in]poster_id_Identifier of the user or chat that posted the story; may be null if the story is posted on behalf of the poster_chat_id.
[in]date_Point in time (Unix timestamp) when the story was published.
[in]is_being_posted_True, if the story is being posted by the current user.
[in]is_being_edited_True, if the story is being edited by the current user.
[in]is_edited_True, if the story was edited.
[in]is_posted_to_chat_page_True, if the story is saved in the profile of the chat that posted it and will be available there after expiration.
[in]is_visible_only_for_self_True, if the story is visible only for the current user.
[in]can_be_added_to_album_True, if the story can be added to an album using createStoryAlbum and addStoryAlbumStories.
[in]can_be_deleted_True, if the story can be deleted.
[in]can_be_edited_True, if the story can be edited.
[in]can_be_forwarded_True, if the story can be forwarded as a message or reposted as a story. Otherwise, screenshotting and saving of the story content must be also forbidden.
[in]can_be_replied_True, if the story can be replied in the chat with the user who posted the story.
[in]can_set_privacy_settings_True, if the story privacy settings can be changed.
[in]can_toggle_is_posted_to_chat_page_True, if the story&#x27;s is_posted_to_chat_page value can be changed.
[in]can_get_statistics_True, if the story statistics are available through getStoryStatistics.
[in]can_get_interactions_True, if interactions with the story can be received through getStoryInteractions.
[in]has_expired_viewers_True, if users viewed the story can&#x27;t be received, because the story has expired more than getOption("story_viewers_expiration_delay") seconds ago.
[in]repost_info_Information about the original story; may be null if the story wasn&#x27;t reposted.
[in]interaction_info_Information about interactions with the story; may be null if the story isn&#x27;t owned or there were no interactions.
[in]chosen_reaction_type_Type of the chosen reaction; may be null if none.
[in]privacy_settings_Privacy rules affecting story visibility; may be approximate for non-owned stories.
[in]content_Content of the story.
[in]areas_Clickable areas to be shown on the story content.
[in]caption_Caption of the story.
[in]album_ids_Identifiers of story albums to which the story is added; only for manageable stories.

Member Function Documentation

◆ store()

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

◆ album_ids_

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

Identifiers of story albums to which the story is added; only for manageable stories.

Definition at line 68610 of file td_api.h.

◆ areas_

array<object_ptr<storyArea> > td::td_api::story::areas_

Clickable areas to be shown on the story content.

Definition at line 68606 of file td_api.h.

◆ can_be_added_to_album_

bool td::td_api::story::can_be_added_to_album_

True, if the story can be added to an album using createStoryAlbum and addStoryAlbumStories.

Definition at line 68576 of file td_api.h.

◆ can_be_deleted_

bool td::td_api::story::can_be_deleted_

True, if the story can be deleted.

Definition at line 68578 of file td_api.h.

◆ can_be_edited_

bool td::td_api::story::can_be_edited_

True, if the story can be edited.

Definition at line 68580 of file td_api.h.

◆ can_be_forwarded_

bool td::td_api::story::can_be_forwarded_

True, if the story can be forwarded as a message or reposted as a story. Otherwise, screenshotting and saving of the story content must be also forbidden.

Definition at line 68582 of file td_api.h.

◆ can_be_replied_

bool td::td_api::story::can_be_replied_

True, if the story can be replied in the chat with the user who posted the story.

Definition at line 68584 of file td_api.h.

◆ can_get_interactions_

bool td::td_api::story::can_get_interactions_

True, if interactions with the story can be received through getStoryInteractions.

Definition at line 68592 of file td_api.h.

◆ can_get_statistics_

bool td::td_api::story::can_get_statistics_

True, if the story statistics are available through getStoryStatistics.

Definition at line 68590 of file td_api.h.

◆ can_set_privacy_settings_

bool td::td_api::story::can_set_privacy_settings_

True, if the story privacy settings can be changed.

Definition at line 68586 of file td_api.h.

◆ can_toggle_is_posted_to_chat_page_

bool td::td_api::story::can_toggle_is_posted_to_chat_page_

True, if the story&#x27;s is_posted_to_chat_page value can be changed.

Definition at line 68588 of file td_api.h.

◆ caption_

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

Caption of the story.

Definition at line 68608 of file td_api.h.

◆ chosen_reaction_type_

object_ptr<ReactionType> td::td_api::story::chosen_reaction_type_

Type of the chosen reaction; may be null if none.

Definition at line 68600 of file td_api.h.

◆ content_

object_ptr<StoryContent> td::td_api::story::content_

Content of the story.

Definition at line 68604 of file td_api.h.

◆ date_

int32 td::td_api::story::date_

Point in time (Unix timestamp) when the story was published.

Definition at line 68564 of file td_api.h.

◆ has_expired_viewers_

bool td::td_api::story::has_expired_viewers_

True, if users viewed the story can&#x27;t be received, because the story has expired more than getOption("story_viewers_expiration_delay") seconds ago.

Definition at line 68594 of file td_api.h.

◆ ID

const std::int32_t td::td_api::story::ID = -1551193142
static

Identifier uniquely determining a type of the object.

Definition at line 68651 of file td_api.h.

◆ id_

int32 td::td_api::story::id_

Unique story identifier among stories posted by the given chat.

Definition at line 68558 of file td_api.h.

◆ interaction_info_

object_ptr<storyInteractionInfo> td::td_api::story::interaction_info_

Information about interactions with the story; may be null if the story isn&#x27;t owned or there were no interactions.

Definition at line 68598 of file td_api.h.

◆ is_being_edited_

bool td::td_api::story::is_being_edited_

True, if the story is being edited by the current user.

Definition at line 68568 of file td_api.h.

◆ is_being_posted_

bool td::td_api::story::is_being_posted_

True, if the story is being posted by the current user.

Definition at line 68566 of file td_api.h.

◆ is_edited_

bool td::td_api::story::is_edited_

True, if the story was edited.

Definition at line 68570 of file td_api.h.

◆ is_posted_to_chat_page_

bool td::td_api::story::is_posted_to_chat_page_

True, if the story is saved in the profile of the chat that posted it and will be available there after expiration.

Definition at line 68572 of file td_api.h.

◆ is_visible_only_for_self_

bool td::td_api::story::is_visible_only_for_self_

True, if the story is visible only for the current user.

Definition at line 68574 of file td_api.h.

◆ poster_chat_id_

int53 td::td_api::story::poster_chat_id_

Identifier of the chat that posted the story.

Definition at line 68560 of file td_api.h.

◆ poster_id_

object_ptr<MessageSender> td::td_api::story::poster_id_

Identifier of the user or chat that posted the story; may be null if the story is posted on behalf of the poster_chat_id.

Definition at line 68562 of file td_api.h.

◆ privacy_settings_

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

Privacy rules affecting story visibility; may be approximate for non-owned stories.

Definition at line 68602 of file td_api.h.

◆ repost_info_

object_ptr<storyRepostInfo> td::td_api::story::repost_info_

Information about the original story; may be null if the story wasn&#x27;t reposted.

Definition at line 68596 of file td_api.h.


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