Class: TD::Types::Message

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

Overview

Describes a message.

Instance Attribute Summary collapse

Method Summary

Methods inherited from Base

#to_hash, #to_json

Instance Attribute Details

#author_signature ⇒ TD::Types::String?

For channel posts and anonymous group messages, optional author signature.

Returns:

  • (TD::Types::String, nil) —

    the current value of author_signature



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def author_signature
  @author_signature
end

#can_be_deleted_for_all_users ⇒ Boolean

True, if the message can be deleted for all users.

Returns:

  • (Boolean) —

    the current value of can_be_deleted_for_all_users



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def can_be_deleted_for_all_users
  @can_be_deleted_for_all_users
end

#can_be_deleted_only_for_self ⇒ Boolean

True, if the message can be deleted only for the current user while other users will continue to see it.

Returns:

  • (Boolean) —

    the current value of can_be_deleted_only_for_self



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def can_be_deleted_only_for_self
  @can_be_deleted_only_for_self
end

#can_be_edited ⇒ Boolean

True, if the message can be edited. For live location and poll messages this fields shows whether editMessageLiveLocation or stopPoll can be used with this message by the application.

Returns:

  • (Boolean) —

    the current value of can_be_edited



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def can_be_edited
  @can_be_edited
end

#can_be_forwarded ⇒ Boolean

True, if the message can be forwarded.

Returns:

  • (Boolean) —

    the current value of can_be_forwarded



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def can_be_forwarded
  @can_be_forwarded
end

#can_get_message_thread ⇒ Boolean

True, if the message thread info is available.

Returns:

  • (Boolean) —

    the current value of can_get_message_thread



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def can_get_message_thread
  @can_get_message_thread
end

#can_get_statistics ⇒ Boolean

True, if the message statistics are available.

Returns:

  • (Boolean) —

    the current value of can_get_statistics



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def can_get_statistics
  @can_get_statistics
end

#chat_id ⇒ Integer

Chat identifier.

Returns:

  • (Integer) —

    the current value of chat_id



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def chat_id
  @chat_id
end

#contains_unread_mention ⇒ Boolean

True, if the message contains an unread mention for the current user.

Returns:

  • (Boolean) —

    the current value of contains_unread_mention



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def contains_unread_mention
  @contains_unread_mention
end

#content ⇒ TD::Types::MessageContent

Content of the message.

Returns:



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def content
  @content
end

#date ⇒ Integer

Point in time (Unix timestamp) when the message was sent.

Returns:

  • (Integer) —

    the current value of date



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def date
  @date
end

#edit_date ⇒ Integer

Point in time (Unix timestamp) when the message was last edited.

Returns:

  • (Integer) —

    the current value of edit_date



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def edit_date
  @edit_date
end

#forward_info ⇒ TD::Types::MessageForwardInfo?

Information about the initial message sender; may be null.

Returns:



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def forward_info
  @forward_info
end

#id ⇒ Integer

Message identifier; unique for the chat to which the message belongs.

Returns:

  • (Integer) —

    the current value of id



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def id
  @id
end

#interaction_info ⇒ TD::Types::MessageInteractionInfo?

Information about interactions with the message; may be null.

Returns:



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def interaction_info
  @interaction_info
end

#is_channel_post ⇒ Boolean

True, if the message is a channel post. All messages to channels are channel posts, all other messages are not channel posts.

Returns:

  • (Boolean) —

    the current value of is_channel_post



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def is_channel_post
  @is_channel_post
end

#is_outgoing ⇒ Boolean

True, if the message is outgoing.

Returns:

  • (Boolean) —

    the current value of is_outgoing



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def is_outgoing
  @is_outgoing
end

#is_pinned ⇒ Boolean

True, if the message is pinned.

Returns:

  • (Boolean) —

    the current value of is_pinned



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def is_pinned
  @is_pinned
end

#media_album_id ⇒ Integer

Unique identifier of an album this message belongs to. Only audios, documents, photos and videos can be grouped together in albums.

Returns:

  • (Integer) —

    the current value of media_album_id



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def media_album_id
  @media_album_id
end

#message_thread_id ⇒ Integer

If non-zero, the identifier of the message thread the message belongs to; unique within the chat to which the message belongs.

Returns:

  • (Integer) —

    the current value of message_thread_id



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def message_thread_id
  @message_thread_id
end

#reply_in_chat_id ⇒ Integer

If non-zero, the identifier of the chat to which the replied message belongs; Currently, only messages in the Replies chat can have different reply_in_chat_id and chat_id.

Returns:

  • (Integer) —

    the current value of reply_in_chat_id



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def reply_in_chat_id
  @reply_in_chat_id
end

#reply_markup ⇒ TD::Types::ReplyMarkup?

Reply markup for the message; may be null.

Returns:



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def reply_markup
  @reply_markup
end

#reply_to_message_id ⇒ Integer

If non-zero, the identifier of the message this message is replying to; can be the identifier of a deleted message.

Returns:

  • (Integer) —

    the current value of reply_to_message_id



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def reply_to_message_id
  @reply_to_message_id
end

#restriction_reason ⇒ TD::Types::String

If non-empty, contains a human-readable description of the reason why access to this message must be restricted.

Returns:

  • (TD::Types::String) —

    the current value of restriction_reason



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def restriction_reason
  @restriction_reason
end

#scheduling_state ⇒ TD::Types::MessageSchedulingState?

Information about the scheduling state of the message; may be null.

Returns:



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def scheduling_state
  @scheduling_state
end

#sender ⇒ TD::Types::MessageSender

The sender of the message.

Returns:



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def sender
  @sender
end

#sending_state ⇒ TD::Types::MessageSendingState?

Information about the sending state of the message; may be null.

Returns:



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def sending_state
  @sending_state
end

#ttl ⇒ Integer

For self-destructing messages, the message’s TTL (Time To Live), in seconds; 0 if none. TDLib will send Update::DeleteMessages or Update::MessageContent once the TTL expires.

Returns:

  • (Integer) —

    the current value of ttl



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def ttl
  @ttl
end

#ttl_expires_in ⇒ Float

Time left before the message expires, in seconds.

Returns:

  • (Float) —

    the current value of ttl_expires_in



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def ttl_expires_in
  @ttl_expires_in
end

#via_bot_user_id ⇒ Integer

If non-zero, the user identifier of the bot through which this message was sent.

Returns:

  • (Integer) —

    the current value of via_bot_user_id



48
49
50
 
# File 'lib/tdlib/types/message.rb', line 48

def via_bot_user_id
  @via_bot_user_id
end