Interface Story

Represents a story.

interface Story {
    @type: "story";
    areas: StoryArea[];
    can_be_deleted?: boolean;
    can_be_edited?: boolean;
    can_be_forwarded?: boolean;
    can_be_replied?: boolean;
    can_get_interactions?: boolean;
    can_get_statistics?: boolean;
    can_toggle_is_posted_to_chat_page?: boolean;
    caption: FormattedText;
    chosen_reaction_type: ReactionType;
    content: StoryContent;
    date: number;
    has_expired_viewers?: boolean;
    id: number;
    interaction_info: StoryInteractionInfo;
    is_being_edited?: boolean;
    is_being_sent?: boolean;
    is_edited?: boolean;
    is_posted_to_chat_page?: boolean;
    is_visible_only_for_self?: boolean;
    privacy_settings: StoryPrivacySettings;
    repost_info: StoryRepostInfo;
    sender_chat_id: number;
    sender_id: MessageSender;
}

Properties

@type: "story"
areas: StoryArea[]

Clickable areas to be shown on the story content.

can_be_deleted?: boolean

True, if the story can be deleted.

can_be_edited?: boolean

True, if the story can be edited.

can_be_forwarded?: boolean

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

can_be_replied?: boolean

True, if the story can be replied in the chat with the story sender.

can_get_interactions?: boolean

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

can_get_statistics?: boolean

True, if the story statistics are available through getStoryStatistics.

can_toggle_is_posted_to_chat_page?: boolean

True, if the story's is_posted_to_chat_page value can be changed.

caption: FormattedText

Caption of the story.

chosen_reaction_type: ReactionType

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

content: StoryContent

Content of the story.

date: number

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

has_expired_viewers?: boolean

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

id: number

Unique story identifier among stories of the given sender.

interaction_info: StoryInteractionInfo

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

is_being_edited?: boolean

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

is_being_sent?: boolean

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

is_edited?: boolean

True, if the story was edited.

is_posted_to_chat_page?: boolean

True, if the story is saved in the sender's profile and will be available there after expiration.

is_visible_only_for_self?: boolean

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

privacy_settings: StoryPrivacySettings

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

repost_info: StoryRepostInfo

Information about the original story; may be null if the story wasn't reposted.

sender_chat_id: number

Identifier of the chat that posted the story.

sender_id: MessageSender

Identifier of the sender of the story; may be null if the story is posted on behalf of the sender_chat_id.