Class: Vk::API::Audio::Methods::GetAlbums

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

Overview

Returns a list of audio albums 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::GetAlbums

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :owner_id (Integer)

    ID of the user or community that owns the audio file.

  • :offset (Integer)

    Offset needed to return a specific subset of albums.

  • :count (Integer)

    Number of albums to return.


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

Instance Method Details

#countInteger

Returns Number of albums to return.

Returns:

  • (Integer)

    Number of albums to return.


29
# File 'lib/vk/api/audio/methods/get_albums.rb', line 29

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

#offsetInteger

Returns Offset needed to return a specific subset of albums.

Returns:

  • (Integer)

    Offset needed to return a specific subset of albums.


27
# File 'lib/vk/api/audio/methods/get_albums.rb', line 27

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

#owner_idInteger

Returns ID of the user or community that owns the audio file.

Returns:

  • (Integer)

    ID of the user or community that owns the audio file.


25
# File 'lib/vk/api/audio/methods/get_albums.rb', line 25

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