Class: Vk::API::Audio::Methods::Add

Inherits:
Schema::Method show all
Defined in:
lib/vk/api/audio/methods/add.rb

Overview

Copies an audio file to a user page or community page.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Audio::Methods::Add

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :audio_id (Integer) —

    Audio file ID.

  • :owner_id (Integer) —

    ID of the user or community that owns the audio file. Use a negative value to designate a community ID. ; ;

  • :group_id (Integer) —

    Community ID, needed when adding the audio file to a community (without minus).

  • :album_id (Integer) —

    Album ID.




# File 'lib/vk/api/audio/methods/add.rb', line 15

Instance Method Details

#album_id ⇒ Integer

Returns Album ID.

Returns:

  • (Integer) —

    Album ID.



32
 
# File 'lib/vk/api/audio/methods/add.rb', line 32

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

#audio_id ⇒ Integer

Returns Audio file ID.

Returns:

  • (Integer) —

    Audio file ID.



26
 
# File 'lib/vk/api/audio/methods/add.rb', line 26

attribute :audio_id, API::Types::Coercible::Int

#group_id ⇒ Integer

Returns Community ID, needed when adding the audio file to a community (without minus).

Returns:

  • (Integer) —

    Community ID, needed when adding the audio file to a community (without minus).



30
 
# File 'lib/vk/api/audio/methods/add.rb', line 30

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

#owner_id ⇒ Integer

Returns ID of the user or community that owns the audio file. Use a negative value to designate a community ID. ; ;.

Returns:

  • (Integer) —

    ID of the user or community that owns the audio file. Use a negative value to designate a community ID. ; ;



28
 
# File 'lib/vk/api/audio/methods/add.rb', line 28

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