Class: Vk::API::Notes::Methods::Edit

Inherits:

Schema::Method

• Object
• Dry::Struct
• Schema::Method
• Vk::API::Notes::Methods::Edit

Defined in:

lib/vk/api/notes/methods/edit.rb

Overview

Edits a note of the current user.

Arguments

• #note_id ⇒ Integer

  Note ID.

• #privacy_comment ⇒ Array
• #privacy_view ⇒ Array
• #text ⇒ String

  Note text.

• #title ⇒ String

  Note title.

Instance Method Summary

• #initialize(arguments) ⇒ Notes::Methods::Edit constructor

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Notes::Methods::Edit

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :note_id (Integer) —

  Note ID.

• :title (String) —

  Note title.

• :text (String) —

  Note text.

• :privacy_view (Array) —

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

• :privacy_comment (Array) —

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

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

Instance Method Details

#note_id ⇒ Integer

Returns Note ID.

Returns:

• (Integer) —

  Note ID.

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

attribute :note_id, API::Types::Coercible::Int

#privacy_comment ⇒ Array

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

Returns:

• (Array) —

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

# File 'lib/vk/api/notes/methods/edit.rb', line 35

attribute :privacy_comment, API::Types::Coercible::Array.member(API::Types::Coercible::String).optional.default([])

#privacy_view ⇒ Array

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

Returns:

• (Array) —

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

# File 'lib/vk/api/notes/methods/edit.rb', line 33

attribute :privacy_view, API::Types::Coercible::Array.member(API::Types::Coercible::String).optional.default([])

#text ⇒ String

Returns Note text.

Returns:

• (String) —

  Note text.

# File 'lib/vk/api/notes/methods/edit.rb', line 31

attribute :text, API::Types::Coercible::String

#title ⇒ String

Returns Note title.

Returns:

• (String) —

  Note title.

# File 'lib/vk/api/notes/methods/edit.rb', line 29

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