Story¶
Represents a story
Story(
id: int32,
poster_chat_id: int53,
poster_id: MessageSender,
date: int32,
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: Bool,
repost_info: StoryRepostInfo,
interaction_info: StoryInteractionInfo,
chosen_reaction_type: ReactionType,
privacy_settings: StoryPrivacySettings,
content: StoryContent,
areas: list of StoryArea,
caption: FormattedText,
album_ids: list of int32
) → Story
id¶
int32
Unique story identifier among stories posted by the given chat
poster_chat_id¶
int53
Identifier of the chat that posted the 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
date¶
int32
Point in time (Unix timestamp) when the story was published
is_being_posted¶
Bool
True, if the story is being posted by the current user
is_being_edited¶
Bool
True, if the story is being edited by the current user
is_edited¶
Bool
True, if the story was edited
is_posted_to_chat_page¶
Bool
True, if the story is saved in the profile of the chat that posted it and will be available there after expiration
is_visible_only_for_self¶
Bool
True, if the story is visible only for the current user
can_be_added_to_album¶
Bool
True, if the story can be added to an album using createStoryAlbum and addStoryAlbumStories
can_be_deleted¶
Bool
True, if the story can be deleted
can_be_edited¶
Bool
True, if the story can be edited
can_be_forwarded¶
Bool
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
can_be_replied¶
Bool
True, if the story can be replied in the chat with the user who posted the story
can_set_privacy_settings¶
Bool
True, if the story privacy settings can be changed
can_toggle_is_posted_to_chat_page¶
Bool
True, if the story's is_posted_to_chat_page value can be changed
can_get_statistics¶
Bool
True, if the story statistics are available through getStoryStatistics
can_get_interactions¶
Bool
True, if interactions with the story can be received through getStoryInteractions
has_expired_viewers¶
Bool
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
repost_info¶
Information about the original story; may be null if the story wasn't reposted
interaction_info¶
Information about interactions with the story; may be null if the story isn't owned or there were no interactions
chosen_reaction_type¶
Type of the chosen reaction; may be null if none
privacy_settings¶
Privacy rules affecting story visibility; may be approximate for non-owned stories
content¶
Content of the story
areas¶
list of StoryArea
Clickable areas to be shown on the story content
caption¶
Caption of the story
album_ids¶
list of int32
Identifiers of story albums to which the story is added; only for manageable stories