Class: Vk::API::Market::Methods::GetAlbumById

Inherits:

Schema::Method

• Object
• Dry::Struct
• Schema::Method
• Vk::API::Market::Methods::GetAlbumById

Defined in:

lib/vk/api/market/methods/get_album_by_id.rb

Overview

Returns items album's data

Arguments

• #album_ids ⇒ Array

  Collections identifiers to obtain data from.

• #owner_id ⇒ Integer

  Identifier of an album owner community; "Note that community id in the 'owner_id' parameter should be negative number.

Instance Method Summary

• #initialize(arguments) ⇒ Market::Methods::GetAlbumById constructor

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Market::Methods::GetAlbumById

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :owner_id (Integer) —

  identifier of an album owner community; "Note that community id in the 'owner_id' parameter should be negative number. For example 'owner_id'=-1 matches the [vk.com/apiclub|VK API] community "

• :album_ids (Array) —

  collections identifiers to obtain data from

# File 'lib/vk/api/market/methods/get_album_by_id.rb', line 15

Instance Method Details

#album_ids ⇒ Array

Returns collections identifiers to obtain data from.

Returns:

• (Array) —

  collections identifiers to obtain data from

# File 'lib/vk/api/market/methods/get_album_by_id.rb', line 26

attribute :album_ids, API::Types::Coercible::Array.member(API::Types::Coercible::Int)

#owner_id ⇒ Integer

Returns identifier of an album owner community; "Note that community id in the 'owner_id' parameter should be negative number. For example 'owner_id'=-1 matches the [vk.com/apiclub|VK API] community ".

Returns:

• (Integer) —

  identifier of an album owner community; "Note that community id in the 'owner_id' parameter should be negative number. For example 'owner_id'=-1 matches the [vk.com/apiclub|VK API] community "

# File 'lib/vk/api/market/methods/get_album_by_id.rb', line 24

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