Class: Vk::API::Audio::Methods::GetBroadcastList

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

Overview

Returns a list of the user's friends and communities that are broadcasting music in their statuses.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :filter (String) —

    Types of objects to return:; 'friends' — only friends; 'groups' — only communities; 'all' — both friends and communities (default)

  • :active (Boolean) —

    '1' — to return only friends and communities that are broadcasting at the moment.; '0' — to return all friends and communities (default).




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

Instance Method Details

#active ⇒ Boolean

Returns '1' — to return only friends and communities that are broadcasting at the moment.; '0' — to return all friends and communities (default).

Returns:

  • (Boolean) —

    '1' — to return only friends and communities that are broadcasting at the moment.; '0' — to return all friends and communities (default).



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

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

#filter ⇒ String

Returns Types of objects to return:; 'friends' — only friends; 'groups' — only communities; 'all' — both friends and communities (default).

Returns:

  • (String) —

    Types of objects to return:; 'friends' — only friends; 'groups' — only communities; 'all' — both friends and communities (default)



24
 
# File 'lib/vk/api/audio/methods/get_broadcast_list.rb', line 24

attribute :filter, API::Types::Coercible::String.enum("all", "friends", "groups").optional.default("all")