List of all members | Public Fields | Public Instance Methods | Static Public Attributes
story Class Referencefinal

Inherits Object.

Description

Represents a story.

Public Fields

int32 id_
 Unique story identifier among stories of the given sender.
 
int53 sender_chat_id_
 Identifier of the chat that posted the story.
 
object_ptr< MessageSendersender_id_
 Identifier of the sender of the story; may be null if the story is posted on behalf of the sender_chat_id.
 
int32 date_
 Point in time (Unix timestamp) when the story was published.
 
bool is_being_sent_
 True, if the story is being sent by the current user.
 
bool is_being_edited_
 True, if the story is being edited 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 sender's profile and will be available there after expiration.
 
bool is_visible_only_for_self_
 True, if the story is visible only for the current user.
 
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. Otherwise, screenshots 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 story sender.
 
bool can_toggle_is_posted_to_chat_page_
 True, if the story's is_posted_to_chat_page value can be changed.
 
bool can_get_statistics_
 True, if the story statistics are available through getStoryStatistics.
 
bool can_get_interactions_
 True, if interactions with the story can be received through getStoryInteractions.
 
bool has_expired_viewers_
 True, if users viewed the story can't be received, because the story has expired more than getOption("story_viewers_expiration_delay") seconds ago.
 
object_ptr< storyRepostInforepost_info_
 Information about the original story; may be null if the story wasn't reposted.
 
object_ptr< storyInteractionInfointeraction_info_
 Information about interactions with the story; may be null if the story isn't owned or there were no interactions.
 
object_ptr< ReactionTypechosen_reaction_type_
 Type of the chosen reaction; may be null if none.
 
object_ptr< StoryPrivacySettingsprivacy_settings_
 Privacy rules affecting story visibility; may be approximate for non-owned stories.
 
object_ptr< StoryContentcontent_
 Content of the story.
 
array< object_ptr< storyArea > > areas_
 Clickable areas to be shown on the story content.
 
object_ptr< formattedTextcaption_
 Caption of the story.
 

Public Instance Methods

 story ()
 
 story (int32 id_, int53 sender_chat_id_, object_ptr< MessageSender > &&sender_id_, int32 date_, bool is_being_sent_, bool is_being_edited_, bool is_edited_, bool is_posted_to_chat_page_, bool is_visible_only_for_self_, bool can_be_deleted_, bool can_be_edited_, bool can_be_forwarded_, bool can_be_replied_, 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_)
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Instance Methods inherited from TlObject
virtual void store (TlStorerUnsafe &s) const
 
virtual void store (TlStorerCalcLength &s) const
 
 TlObject ()=default
 
 TlObject (const TlObject &)=delete
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Static Public Attributes

static const std::int32_t ID = -294015331
 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  sender_chat_id_,
object_ptr< MessageSender > &&  sender_id_,
int32  date_,
bool  is_being_sent_,
bool  is_being_edited_,
bool  is_edited_,
bool  is_posted_to_chat_page_,
bool  is_visible_only_for_self_,
bool  can_be_deleted_,
bool  can_be_edited_,
bool  can_be_forwarded_,
bool  can_be_replied_,
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_ 
)

Represents a story.

Parameters
[in]id_Unique story identifier among stories of the given sender.
[in]sender_chat_id_Identifier of the chat that posted the story.
[in]sender_id_Identifier of the sender of the story; may be null if the story is posted on behalf of the sender_chat_id.
[in]date_Point in time (Unix timestamp) when the story was published.
[in]is_being_sent_True, if the story is being sent 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 sender's profile 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_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. Otherwise, screenshots 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 story sender.
[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 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.

Method Documentation

◆ store()

void store ( TlStorerToString &  s,
const char *  field_name 
) const
finalvirtual

Helper function for to_string method. Appends string representation of the object to the storer.

Parameters
[in]sStorer to which object string representation will be appended.
[in]field_nameObject field_name if applicable.

Implements TlObject.


The documentation for this class was generated from the following file: