Class: Vk::API::Audio::Methods::Get

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

Overview

Returns a list of audio files of a user or community.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :owner_id (Integer)

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

  • :album_id (Integer)

    Audio album ID.

  • :audio_ids (Array)

    IDs of the audio files to return.

  • :need_user (Boolean)

    '1' — to return information about users who uploaded audio files

  • :offset (Integer)

    Offset needed to return a specific subset of audio files.

  • :count (Integer)

    Number of audio files to return.


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

Instance Method Details

#album_idInteger

Returns Audio album ID.

Returns:

  • (Integer)

    Audio album ID.


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

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

#audio_idsArray

Returns IDs of the audio files to return.

Returns:

  • (Array)

    IDs of the audio files to return.


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

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

#countInteger

Returns Number of audio files to return.

Returns:

  • (Integer)

    Number of audio files to return.


38
# File 'lib/vk/api/audio/methods/get.rb', line 38

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

#need_userBoolean

Returns '1' — to return information about users who uploaded audio files.

Returns:

  • (Boolean)

    '1' — to return information about users who uploaded audio files


34
# File 'lib/vk/api/audio/methods/get.rb', line 34

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

#offsetInteger

Returns Offset needed to return a specific subset of audio files.

Returns:

  • (Integer)

    Offset needed to return a specific subset of audio files.


36
# File 'lib/vk/api/audio/methods/get.rb', line 36

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

#owner_idInteger

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/get.rb', line 28

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