Class: TD::Types::Story

Inherits:
Base
  • Object
show all
Defined in:
lib/tdlib/types/story.rb

Overview

Represents a story.

Instance Attribute Summary collapse

Method Summary

Methods inherited from Base

#to_hash, #to_json

Instance Attribute Details

#areas ⇒ Array<TD::Types::StoryArea>

Clickable areas to be shown on the story content.

Returns:



36
37
38
 
# File 'lib/tdlib/types/story.rb', line 36

def areas
  @areas
end

#can_be_deleted ⇒ Boolean

True, if the story can be deleted.

Returns:

  • (Boolean) —

    the current value of can_be_deleted



36
37
38
 
# File 'lib/tdlib/types/story.rb', line 36

def can_be_deleted
  @can_be_deleted
end

#can_be_edited ⇒ Boolean

True, if the story can be edited.

Returns:

  • (Boolean) —

    the current value of can_be_edited



36
37
38
 
# File 'lib/tdlib/types/story.rb', line 36

def can_be_edited
  @can_be_edited
end

#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.

Returns:

  • (Boolean) —

    the current value of can_be_forwarded



36
37
38
 
# File 'lib/tdlib/types/story.rb', line 36

def can_be_forwarded
  @can_be_forwarded
end

#can_be_replied ⇒ Boolean

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

Returns:

  • (Boolean) —

    the current value of can_be_replied



36
37
38
 
# File 'lib/tdlib/types/story.rb', line 36

def can_be_replied
  @can_be_replied
end

#can_get_interactions ⇒ Boolean

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

Returns:

  • (Boolean) —

    the current value of can_get_interactions



36
37
38
 
# File 'lib/tdlib/types/story.rb', line 36

def can_get_interactions
  @can_get_interactions
end

#can_get_statistics ⇒ Boolean

True, if the story statistics are available through getStoryStatistics.

Returns:

  • (Boolean) —

    the current value of can_get_statistics



36
37
38
 
# File 'lib/tdlib/types/story.rb', line 36

def can_get_statistics
  @can_get_statistics
end

#can_toggle_is_posted_to_chat_page ⇒ Boolean

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

Returns:

  • (Boolean) —

    the current value of can_toggle_is_posted_to_chat_page



36
37
38
 
# File 'lib/tdlib/types/story.rb', line 36

def can_toggle_is_posted_to_chat_page
  @can_toggle_is_posted_to_chat_page
end

#caption ⇒ TD::Types::FormattedText

Caption of the story.

Returns:



36
37
38
 
# File 'lib/tdlib/types/story.rb', line 36

def caption
  @caption
end

#chosen_reaction_type ⇒ TD::Types::ReactionType?

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

Returns:



36
37
38
 
# File 'lib/tdlib/types/story.rb', line 36

def chosen_reaction_type
  @chosen_reaction_type
end

#content ⇒ TD::Types::StoryContent

Content of the story.

Returns:



36
37
38
 
# File 'lib/tdlib/types/story.rb', line 36

def content
  @content
end

#date ⇒ Integer

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

Returns:

  • (Integer) —

    the current value of date



36
37
38
 
# File 'lib/tdlib/types/story.rb', line 36

def date
  @date
end

#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.

Returns:

  • (Boolean) —

    the current value of has_expired_viewers



36
37
38
 
# File 'lib/tdlib/types/story.rb', line 36

def has_expired_viewers
  @has_expired_viewers
end

#id ⇒ Integer

Unique story identifier among stories of the given sender.

Returns:

  • (Integer) —

    the current value of id



36
37
38
 
# File 'lib/tdlib/types/story.rb', line 36

def id
  @id
end

#interaction_info ⇒ TD::Types::StoryInteractionInfo?

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

Returns:



36
37
38
 
# File 'lib/tdlib/types/story.rb', line 36

def interaction_info
  @interaction_info
end

#is_being_edited ⇒ Boolean

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

Returns:

  • (Boolean) —

    the current value of is_being_edited



36
37
38
 
# File 'lib/tdlib/types/story.rb', line 36

def is_being_edited
  @is_being_edited
end

#is_being_sent ⇒ Boolean

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

Returns:

  • (Boolean) —

    the current value of is_being_sent



36
37
38
 
# File 'lib/tdlib/types/story.rb', line 36

def is_being_sent
  @is_being_sent
end

#is_edited ⇒ Boolean

True, if the story was edited.

Returns:

  • (Boolean) —

    the current value of is_edited



36
37
38
 
# File 'lib/tdlib/types/story.rb', line 36

def is_edited
  @is_edited
end

#is_posted_to_chat_page ⇒ Boolean

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

Returns:

  • (Boolean) —

    the current value of is_posted_to_chat_page



36
37
38
 
# File 'lib/tdlib/types/story.rb', line 36

def is_posted_to_chat_page
  @is_posted_to_chat_page
end

#is_visible_only_for_self ⇒ Boolean

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

Returns:

  • (Boolean) —

    the current value of is_visible_only_for_self



36
37
38
 
# File 'lib/tdlib/types/story.rb', line 36

def is_visible_only_for_self
  @is_visible_only_for_self
end

#privacy_settings ⇒ TD::Types::StoryPrivacySettings

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

Returns:



36
37
38
 
# File 'lib/tdlib/types/story.rb', line 36

def privacy_settings
  @privacy_settings
end

#repost_info ⇒ TD::Types::StoryRepostInfo?

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

Returns:



36
37
38
 
# File 'lib/tdlib/types/story.rb', line 36

def repost_info
  @repost_info
end

#sender_chat_id ⇒ Integer

Identifier of the chat that posted the story.

Returns:

  • (Integer) —

    the current value of sender_chat_id



36
37
38
 
# File 'lib/tdlib/types/story.rb', line 36

def sender_chat_id
  @sender_chat_id
end

#sender_id ⇒ TD::Types::MessageSender?

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

Returns:



36
37
38
 
# File 'lib/tdlib/types/story.rb', line 36

def sender_id
  @sender_id
end