Class: Vk::API::Market::Methods::AddAlbum

Inherits:

Schema::Method

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

Defined in:

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

Overview

Creates new collection of items

Arguments

• #main_album ⇒ Boolean

  Set as main ('1' – set, '0' – no).

• #owner_id ⇒ Integer

  ID of an item owner community.

• #photo_id ⇒ Integer

  Cover photo ID.

• #title ⇒ String

  Collection title.

Instance Method Summary

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

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :owner_id (Integer) —

  ID of an item owner community.

• :title (String) —

  Collection title.

• :photo_id (Integer) —

  Cover photo ID.

• :main_album (Boolean) —

  Set as main ('1' – set, '0' – no).

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

Instance Method Details

#main_album ⇒ Boolean

Returns Set as main ('1' – set, '0' – no).

Returns:

• (Boolean) —

  Set as main ('1' – set, '0' – no).

# File 'lib/vk/api/market/methods/add_album.rb', line 32

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

#owner_id ⇒ Integer

Returns ID of an item owner community.

Returns:

• (Integer) —

  ID of an item owner community.

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

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

#photo_id ⇒ Integer

Returns Cover photo ID.

Returns:

• (Integer) —

  Cover photo ID.

# File 'lib/vk/api/market/methods/add_album.rb', line 30

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

#title ⇒ String

Returns Collection title.

Returns:

• (String) —

  Collection title.

# File 'lib/vk/api/market/methods/add_album.rb', line 28

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