Class: Vk::API::Notes::Methods::Get

Inherits:

Schema::Method

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

Defined in:

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

Overview

Returns a list of notes created by a user.

Arguments

• #count ⇒ Integer

  Number of notes to return.

• #note_ids ⇒ Array

  Note IDs.

• #user_id ⇒ Integer

  Note owner ID.

Instance Method Summary

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

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :note_ids (Array) —

  Note IDs.

• :user_id (Integer) —

  Note owner ID.

• :count (Integer) —

  Number of notes to return.

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

Instance Method Details

#count ⇒ Integer

Returns Number of notes to return.

Returns:

• (Integer) —

  Number of notes to return.

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

attribute :count, API::Types::Coercible::Int.optional.default(20)

#note_ids ⇒ Array

Returns Note IDs.

Returns:

• (Array) —

  Note IDs.

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

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

#user_id ⇒ Integer

Returns Note owner ID.

Returns:

• (Integer) —

  Note owner ID.

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

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