Class: Vk::API::Audio::Methods::GetRecommendations

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

Overview

Returns a list of suggested audio files based on a user's playlist or a particular audio file.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :target_audio (String)

    Use to get recommendations based on a particular audio file. The ID of the user or community that owns an audio file and that audio file's ID, separated by an underscore.;

  • :user_id (Integer)

    Use to get recommendations based on a user's playlist. User ID. By default, the current user ID.;

  • :offset (Integer)

    Offset needed to return a specific subset of audio files.

  • :count (Integer)

    Number of audio files to return.

  • :shuffle (Boolean)

    '1' — shuffle on


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

Instance Method Details

#countInteger

Returns Number of audio files to return.

Returns:

  • (Integer)

    Number of audio files to return.


33
# File 'lib/vk/api/audio/methods/get_recommendations.rb', line 33

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

#offsetInteger

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

Returns:

  • (Integer)

    Offset needed to return a specific subset of audio files.


31
# File 'lib/vk/api/audio/methods/get_recommendations.rb', line 31

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

#shuffleBoolean

Returns '1' — shuffle on.

Returns:

  • (Boolean)

    '1' — shuffle on


35
# File 'lib/vk/api/audio/methods/get_recommendations.rb', line 35

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

#target_audioString

Returns Use to get recommendations based on a particular audio file. The ID of the user or community that owns an audio file and that audio file's ID, separated by an underscore.;.

Returns:

  • (String)

    Use to get recommendations based on a particular audio file. The ID of the user or community that owns an audio file and that audio file's ID, separated by an underscore.;


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

attribute :target_audio, API::Types::Coercible::String.optional.default(nil)

#user_idInteger

Returns Use to get recommendations based on a user's playlist. User ID. By default, the current user ID.;.

Returns:

  • (Integer)

    Use to get recommendations based on a user's playlist. User ID. By default, the current user ID.;


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

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