Story class final
Represents a story
Constructors
-
Story({required int id, required int senderChatId, MessageSender? senderId, required int date, required bool isBeingSent, required bool isBeingEdited, required bool isEdited, required bool isPinned, required bool isVisibleOnlyForSelf, required bool canBeDeleted, required bool canBeEdited, required bool canBeForwarded, required bool canBeReplied, required bool canToggleIsPinned, required bool canGetStatistics, required bool canGetInteractions, required bool hasExpiredViewers, StoryRepostInfo? repostInfo, StoryInteractionInfo? interactionInfo, ReactionType? chosenReactionType, required StoryPrivacySettings privacySettings, required StoryContent content, required List<
StoryArea> areas, required FormattedText caption, dynamic extra, int? clientId}) -
Represents a story
const
-
Story.fromJson(Map<
String, dynamic> json) -
Parses a Story from TDLib JSON.
factory
Properties
-
areas
→ List<
StoryArea> -
Clickable areas to be shown on the story content
final
- canBeDeleted → bool
-
True, if the story can be deleted
final
- canBeEdited → bool
-
True, if the story can be edited
final
- canBeForwarded → bool
-
True, if the story can be forwarded as a message. Otherwise, screenshots and saving of the story content must be also forbidden
final
- canBeReplied → bool
-
True, if the story can be replied in the chat with the story sender
final
- canGetInteractions → bool
-
True, if interactions with the story can be received through getStoryInteractions
final
- canGetStatistics → bool
-
True, if the story statistics are available through getStoryStatistics
final
- canToggleIsPinned → bool
-
True, if the story's is_pinned value can be changed
final
- caption → FormattedText
-
Caption of the story
final
- chosenReactionType → ReactionType?
-
Type of the chosen reaction; may be null if none
final
- clientId → int?
-
Identifier of the TDLib client that sent this object.
final
- content → StoryContent
-
Content of the story
final
- date → int
-
Point in time (Unix timestamp) when the story was published
final
- extra → dynamic
-
"@extra" of the request this object answers.
final
- hasExpiredViewers → bool
-
True, if users viewed the story can't be received, because the story has expired more than getOption("story_viewers_expiration_delay") seconds ago
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → int
-
Unique story identifier among stories of the given sender
final
- interactionInfo → StoryInteractionInfo?
-
Information about interactions with the story; may be null if the story isn't owned or there were no interactions
final
- isBeingEdited → bool
-
True, if the story is being edited by the current user
final
- isBeingSent → bool
-
True, if the story is being sent by the current user
final
- isEdited → bool
-
True, if the story was edited
final
- isPinned → bool
-
True, if the story is saved in the sender's profile and will be available there after expiration
final
- isVisibleOnlyForSelf → bool
-
True, if the story is visible only for the current user
final
- privacySettings → StoryPrivacySettings
-
Privacy rules affecting story visibility; may be approximate for non-owned stories
final
- repostInfo → StoryRepostInfo?
-
Information about the original story; may be null if the story wasn't reposted
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- senderChatId → int
-
Identifier of the chat that posted the story
final
- senderId → MessageSender?
-
Identifier of the sender of the story; may be null if the story is posted on behalf of the sender_chat_id
final
Methods
-
copyWith(
{int? id, int? senderChatId, MessageSender? senderId()?, int? date, bool? isBeingSent, bool? isBeingEdited, bool? isEdited, bool? isPinned, bool? isVisibleOnlyForSelf, bool? canBeDeleted, bool? canBeEdited, bool? canBeForwarded, bool? canBeReplied, bool? canToggleIsPinned, bool? canGetStatistics, bool? canGetInteractions, bool? hasExpiredViewers, StoryRepostInfo? repostInfo()?, StoryInteractionInfo? interactionInfo()?, ReactionType? chosenReactionType()?, StoryPrivacySettings? privacySettings, StoryContent? content, List< StoryArea> ? areas, FormattedText? caption, dynamic extra, int? clientId}) → Story -
Returns a copy with the given fields replaced. For a nullable
field pass a function, e.g.
field: () => nullto clear it. -
getConstructor(
) → String -
TDLib type name, e.g.
updateNewMessage.override -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
Converts this object to TDLib JSON.
override
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
- CONSTRUCTOR → const String
- TDLib type name.