Class Story

constructor

• new Story(raw: RawStoryItem, _peers: PeersIndex): Story

  Parameters

  • raw: RawStoryItem
  • _peers: PeersIndex

  Returns Story

Readonly_peers

Readonlyraw

albums

• get albums(): number[]

  Albums this story belongs to

  Returns number[]

caption

• get caption(): string | null

  Caption of the story

  Returns string | null

date

• get date(): Date

  Date when this story was posted

  Returns Date

entities

• get entities(): readonly MessageEntity[]

  Caption entities (may be empty)

  Returns readonly MessageEntity[]

expireDate

• get expireDate(): Date

  Date when this story will expire

  Returns Date

id

• get id(): number

  ID of the story

  Returns number

interactions

• get interactions(): StoryInteractions | null

  Information about story interactions

  Returns StoryInteractions | null

interactiveElements

• get interactiveElements(): StoryInteractiveElement[]

  Interactive elements of the story

  Returns StoryInteractiveElement[]

isActive

• get isActive(): boolean

  Whether the story is active (i.e. not expired yet)

  Returns boolean

isContentProtected

• get isContentProtected(): boolean

  Whether this story is content-protected, i.e. can't be forwarded

  Returns boolean

isEdited

• get isEdited(): boolean

  Whether this story has been edited

  Returns boolean

isMy

• get isMy(): boolean

  Whether this story has been posted by the current user

  Returns boolean

isPinned

• get isPinned(): boolean

  Whether this story is pinned

  Returns boolean

isShort

• get isShort(): boolean

  Whether this object contains reduced set of fields.

  When true, these field will not contain correct data: privacyRules, interactiveAreas

  Returns boolean

media

• get media(): StoryMedia

  Story media.

  Currently, can only be Photo or Video.

  Returns StoryMedia

privacyRules

• get privacyRules(): TypePrivacyRule[] | null

  Privacy rules of the story.

  Only available when isMy is true.

  Returns TypePrivacyRule[] | null

sentReactionEmoji

• get sentReactionEmoji(): ReactionEmoji | null

  Emoji representing a reaction sent by the current user, if any

  Returns ReactionEmoji | null

visibility

• get visibility(): StoryVisibility

  Story visibility

  Returns StoryVisibility