Class: Vk::API::Notes::Note

Inherits:

Schema::Object

• Object
• Dry::Struct
• Schema::Object
• Vk::API::Notes::Note

Defined in:

lib/vk/api/notes/note.rb

Overview

See Also:

• https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

Instance Method Summary

• #can_comment ⇒ API::Base::BoolInt

  Information whether current user can comment the note.

• #comments ⇒ Integer

  Comments number.

• #date ⇒ Integer

  Date when the note has been created in Unixtime.

• #id ⇒ Integer

  Note ID.

• #owner_id ⇒ Integer

  Note owner's ID.

• #text ⇒ String

  Note text.

• #text_wiki ⇒ String

  Note text in wiki format.

• #title ⇒ String

  Note title.

• #view_url ⇒ String

  URL of the page with note preview.

Instance Method Details

#can_comment ⇒ API::Base::BoolInt

Returns Information whether current user can comment the note.

Returns:

• (API::Base::BoolInt) —

  Information whether current user can comment the note

# File 'lib/vk/api/notes/note.rb', line 17

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

#comments ⇒ Integer

Returns Comments number.

Returns:

• (Integer) —

  Comments number

# File 'lib/vk/api/notes/note.rb', line 15

attribute :comments, API::Types::Coercible::Int

#date ⇒ Integer

Returns Date when the note has been created in Unixtime.

Returns:

• (Integer) —

  Date when the note has been created in Unixtime

# File 'lib/vk/api/notes/note.rb', line 19

attribute :date, API::Types::Coercible::Int

#id ⇒ Integer

Returns Note ID.

Returns:

• (Integer) —

  Note ID

# File 'lib/vk/api/notes/note.rb', line 11

attribute :id, API::Types::Coercible::Int

#owner_id ⇒ Integer

Returns Note owner's ID.

Returns:

• (Integer) —

  Note owner's ID

# File 'lib/vk/api/notes/note.rb', line 13

attribute :owner_id, API::Types::Coercible::Int

#text ⇒ String

Returns Note text.

Returns:

• (String) —

  Note text

# File 'lib/vk/api/notes/note.rb', line 23

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

#text_wiki ⇒ String

Returns Note text in wiki format.

Returns:

• (String) —

  Note text in wiki format

# File 'lib/vk/api/notes/note.rb', line 25

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

#title ⇒ String

Returns Note title.

Returns:

• (String) —

  Note title

# File 'lib/vk/api/notes/note.rb', line 21

attribute :title, API::Types::Coercible::String

#view_url ⇒ String

Returns URL of the page with note preview.

Returns:

• (String) —

  URL of the page with note preview

# File 'lib/vk/api/notes/note.rb', line 27

attribute :view_url, API::Types::Coercible::String