story Class Referencefinal
Inherits Object.
Description
Represents a story.
Public Member Functions | |
| void | store (TlStorerToString &s, const char *field_name) const final |
| 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_) | |
| 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 | |
| array< int32 > | album_ids_ |
| Identifiers of story albums to which the story is added; only for manageable stories. | |
| array< object_ptr< storyArea > > | areas_ |
| Clickable areas to be shown on the story content. | |
| 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_get_interactions_ |
| True, if interactions with the story can be received through getStoryInteractions. | |
| bool | can_get_statistics_ |
| True, if the story statistics are available through getStoryStatistics. | |
| 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's is_posted_to_chat_page value can be changed. | |
| object_ptr< formattedText > | caption_ |
| Caption of the story. | |
| object_ptr< ReactionType > | chosen_reaction_type_ |
| Type of the chosen reaction; may be null if none. | |
| object_ptr< StoryContent > | content_ |
| Content of the story. | |
| int32 | date_ |
| Point in time (Unix timestamp) when the story was published. | |
| bool | has_expired_viewers_ |
| True, if users who viewed the story can't be received, because the story has expired more than getOption("story_viewers_expiration_delay") seconds ago. | |
| int32 | id_ |
| Unique story identifier among stories posted by the given chat. | |
| object_ptr< storyInteractionInfo > | interaction_info_ |
| Information about interactions with the story; may be null if the story isn't owned or there were no interactions. | |
| bool | is_being_edited_ |
| True, if the story is being edited by the current user. | |
| bool | is_being_posted_ |
| True, if the story is being posted 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. | |
| int53 | poster_chat_id_ |
| Identifier of the chat that posted the story. | |
| object_ptr< MessageSender > | 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. | |
| object_ptr< StoryPrivacySettings > | privacy_settings_ |
| Privacy rules affecting story visibility; may be approximate for non-owned stories. | |
| object_ptr< storyRepostInfo > | repost_info_ |
| Information about the original story; may be null if the story wasn't reposted. | |
Static Public Attributes | |
| static const std::int32_t | ID = -1551193142 |
| Identifier uniquely determining a type of the object. | |
Constructor & Destructor Documentation
◆ story() [1/2]
| story | ( | ) |
Represents a story.
◆ story() [2/2]
| 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'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 who viewed the story can'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't reposted. [in] interaction_info_ Information about interactions with the story; may be null if the story isn'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()
|
finalvirtual |
The documentation for this class was generated from the following file:
- td/generate/auto/td/telegram/td_api.h
Generated by
1.17.0