Class: Vk::API::Audio::Methods::GetPopular

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

Overview

Returns a list of audio files from the "Popular".

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :only_eng (Boolean) —

    '1' — to return only foreign audio files; '0' — to return all audio files;

  • :genre_id (Integer) —

    Genre ID. See .

  • :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_popular.rb', line 15

Instance Method Details

#count ⇒ Integer

Returns Number of audio files to return.

Returns:

  • (Integer) —

    Number of audio files to return.



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

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

#genre_id ⇒ Integer

Returns Genre ID. See .

Returns:

  • (Integer) —

    Genre ID. See .



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

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

#offset ⇒ Integer

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

Returns:

  • (Integer) —

    Offset needed to return a specific subset of audio files.



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

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

#only_eng ⇒ Boolean

Returns '1' — to return only foreign audio files; '0' — to return all audio files;.

Returns:

  • (Boolean) —

    '1' — to return only foreign audio files; '0' — to return all audio files;



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

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