Class: Vk::API::Messages::Message

Inherits:
Schema::Object show all
Defined in:
lib/vk/api/messages/message.rb

Overview

See Also:

Instance Method Summary collapse

Instance Method Details

#admin_id ⇒ Integer

Returns Chat administrator ID.

Returns:

  • (Integer) —

    Chat administrator ID



41
 
# File 'lib/vk/api/messages/message.rb', line 41

attribute :admin_id, API::Types::Coercible::Int.optional.default(nil)

#attachments ⇒ Array

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:



33
 
# File 'lib/vk/api/messages/message.rb', line 33

attribute :attachments, API::Types::Coercible::Array.member(API::Messages::MessageAttachment).optional.default(nil)

#body ⇒ String

Returns Message text.

Returns:

  • (String) —

    Message text



31
 
# File 'lib/vk/api/messages/message.rb', line 31

attribute :body, API::Types::Coercible::String.optional.default(nil)

#chat_active ⇒ Array

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:



37
 
# File 'lib/vk/api/messages/message.rb', line 37

attribute :chat_active, API::Types::Coercible::Array.member(API::Types::Coercible::Int).optional.default(nil)

#chat_id ⇒ Integer

Returns Chat ID.

Returns:

  • (Integer) —

    Chat ID



35
 
# File 'lib/vk/api/messages/message.rb', line 35

attribute :chat_id, API::Types::Coercible::Int.optional.default(nil)

#date ⇒ Integer

Returns Date when the message has been sent in Unixtime.

Returns:

  • (Integer) —

    Date when the message has been sent in Unixtime



13
 
# File 'lib/vk/api/messages/message.rb', line 13

attribute :date, API::Types::Coercible::Int.optional.default(nil)

#deleted ⇒ Boolean

Returns Is it an deleted message.

Returns:

  • (Boolean) —

    Is it an deleted message



23
 
# File 'lib/vk/api/messages/message.rb', line 23

attribute :deleted, API::Types::Form::Bool.optional.default(nil)

#fwd_messages ⇒ Array

Returns Forwarded messages.

Returns:

  • (Array) —

    Forwarded messages



25
 
# File 'lib/vk/api/messages/message.rb', line 25

attribute :fwd_messages, API::Types::Coercible::Array.member(API::Messages::Message).optional.default(nil)

#geo ⇒ API::Base::Geo

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:



49
 
# File 'lib/vk/api/messages/message.rb', line 49

attribute :geo, Dry::Types[API::Base::Geo].optional.default(nil)

#id ⇒ Integer

Returns Message ID.

Returns:

  • (Integer) —

    Message ID



11
 
# File 'lib/vk/api/messages/message.rb', line 11

attribute :id, API::Types::Coercible::Int.optional.default(nil)

#important ⇒ Boolean

Returns Is it an important message.

Returns:

  • (Boolean) —

    Is it an important message



21
 
# File 'lib/vk/api/messages/message.rb', line 21

attribute :important, API::Types::Form::Bool.optional.default(nil)

#out ⇒ API::Base::BoolInt

Returns Information whether the message is outcoming.

Returns:



15
 
# File 'lib/vk/api/messages/message.rb', line 15

attribute :out, API::Base::BoolInt.optional.default(nil)

#photo_100 ⇒ String

Returns URL of the preview image with 100px in width.

Returns:

  • (String) —

    URL of the preview image with 100px in width



45
 
# File 'lib/vk/api/messages/message.rb', line 45

attribute :photo_100, API::Types::Coercible::String.optional.default(nil)

#photo_200 ⇒ String

Returns URL of the preview image with 200px in width.

Returns:

  • (String) —

    URL of the preview image with 200px in width



47
 
# File 'lib/vk/api/messages/message.rb', line 47

attribute :photo_200, API::Types::Coercible::String.optional.default(nil)

#photo_50 ⇒ String

Returns URL of the preview image with 50px in width.

Returns:

  • (String) —

    URL of the preview image with 50px in width



43
 
# File 'lib/vk/api/messages/message.rb', line 43

attribute :photo_50, API::Types::Coercible::String.optional.default(nil)

#random_id ⇒ Integer

Returns ID used for sending messages. It returned only for outgoing messages.

Returns:

  • (Integer) —

    ID used for sending messages. It returned only for outgoing messages



19
 
# File 'lib/vk/api/messages/message.rb', line 19

attribute :random_id, API::Types::Coercible::Int.optional.default(nil)

#read_state ⇒ API::Base::BoolInt

Returns Information whether the messages is read.

Returns:



27
 
# File 'lib/vk/api/messages/message.rb', line 27

attribute :read_state, API::Base::BoolInt.optional.default(nil)

#title ⇒ String

Returns Message title or chat title.

Returns:

  • (String) —

    Message title or chat title



29
 
# File 'lib/vk/api/messages/message.rb', line 29

attribute :title, API::Types::Coercible::String.optional.default(nil)

#user_id ⇒ Integer

Returns Message author's ID.

Returns:

  • (Integer) —

    Message author's ID



17
 
# File 'lib/vk/api/messages/message.rb', line 17

attribute :user_id, API::Types::Coercible::Int.optional.default(nil)

#users_count ⇒ Integer

Returns Chat users number.

Returns:

  • (Integer) —

    Chat users number



39
 
# File 'lib/vk/api/messages/message.rb', line 39

attribute :users_count, API::Types::Coercible::Int.optional.default(nil)