MadelineProtoDocs/docs/API_docs/constructors/storyItem.md

title	description	nav_exclude	image
storyItem	Represents a story.	true	https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

Constructor: storyItem

Back to constructors index

Represents a story.

Attributes:

Name	Type	Required	Description
pinned	Bool	Optional	Whether this story is pinned on the user's profile
public	Bool	Optional	Whether this story is public and can be viewed by everyone
close_friends	Bool	Optional	Whether this story can only be viewed by our close friends, see here » for more info
min	Bool	Optional	Full information about this story was omitted for space and performance reasons; use stories.getStoriesByID to fetch full info about this story when and if needed.
noforwards	Bool	Optional	Whether this story is protected and thus cannot be forwarded; clients should also prevent users from saving attached media (i.e. videos should only be streamed, photos should be kept in RAM, et cetera).
edited	Bool	Optional	Indicates whether the story was edited.
contacts	Bool	Optional	Whether this story can only be viewed by our contacts
selected_contacts	Bool	Optional	Whether this story can only be viewed by a select list of our contacts
out	Bool	Optional	indicates whether we sent this story.
id	int	Yes	ID of the story.
date	int	Yes	When was the story posted.
from_id	Peer	Optional
fwd_from	StoryFwdHeader	Optional	For reposted stories », contains info about the original story.
expire_date	int	Yes	When does the story expire.
caption	string	Optional	Story caption.
entities	Array of MessageEntity	Optional	Message entities for styled text
parse_mode	string	Whether to parse HTML or Markdown markup in the message	Optional
media	MessageMedia	Optional	Story media.
media_areas	Array of MediaArea	Optional	List of media areas, see here » for more info on media areas.
privacy	Array of PrivacyRule	Optional	Privacy rules indicating who can and can't view this story
views	StoryViews	Optional	View date and reaction information
sent_reaction	Reaction	Optional	The reaction we sent.

Type: StoryItem

Usage of parse_mode:

Set parse_mode to html to enable HTML parsing of the message.

Set parse_mode to Markdown to enable markdown parsing of the message.

The following tags are currently supported:

<br>a newline
<b><i>bold works ok, internal tags are stripped</i> </b>
<strong>bold</strong>
<em>italic</em>
<i>italic</i>
<u>underline</u>
<s>strikethrough</s>
<del>strikethrough</del>
<strike>strikethrough</strike>
<code>inline fixed-width code</code>
<pre>pre-formatted fixed-width code block</pre>
<blockquote>pre-formatted fixed-width code block</blockquote>
<a href="https://github.com">URL</a>
<a href="mention:@danogentili">Mention by username</a>
<a href="mention:186785362">Mention by user id</a>
<a href="tg://user?id=186785362">Mention by user id</a>
Custom emoji: <emoji id="5368324170671202286">👍</emoji>
Custom emoji: <tg-emoji emoji-id="5368324170671202286">👍</tg-emoji>
<pre language="json">Pre tags can have a language attribute</pre>
<spoiler>Spoiler</spoiler>
<tg-spoiler>Spoiler</tg-spoiler>

You can also use normal markdown (bot API MarkdownV2 syntax), note that to create mentions you can also use the mention: syntax like in html:

*bold \*text*
_italic \*text_
__underline__
~strikethrough~
||spoiler||
*bold _italic bold ~italic bold strikethrough ||italic bold strikethrough spoiler||~ __underline italic bold___ bold*
[inline URL](http://www.example.com/)
[inline mention of a user](tg://user?id=123456789)
![👍](tg://emoji?id=5368324170671202286)
\`inline fixed-width code\`
\`\`\`
pre-formatted fixed-width code block
\`\`\`
\`\`\`php
pre-formatted fixed-width code block written in the PHP programming language
\`\`\`

[Mention by username](mention:@danogentili)
[Mention by user id](mention:186785362)
[Mention by user id](tg://user?id=186785362)
[👍](emoji:5368324170671202286)
[👍](tg://emoji?id=5368324170671202286)

Example:

$storyItem = ['_' => 'storyItem', 'pinned' => Bool, 'public' => Bool, 'close_friends' => Bool, 'min' => Bool, 'noforwards' => Bool, 'edited' => Bool, 'contacts' => Bool, 'selected_contacts' => Bool, 'out' => Bool, 'id' => int, 'date' => int, 'from_id' => Peer, 'fwd_from' => StoryFwdHeader, 'expire_date' => int, 'caption' => 'string', 'entities' => [MessageEntity, MessageEntity]parse_mode: 'string', , 'media' => MessageMedia, 'media_areas' => [MediaArea, MediaArea], 'privacy' => [PrivacyRule, PrivacyRule], 'views' => StoryViews, 'sent_reaction' => Reaction];