Class: Vk::API::Audio::Methods::SetBroadcast

Inherits:

Schema::Method

Object
Dry::Struct
Schema::Method
Vk::API::Audio::Methods::SetBroadcast

show all

Defined in:: lib/vk/api/audio/methods/set_broadcast.rb

Overview

Activates an audio broadcast to the status of a user or community.

Arguments collapse

#audio ⇒ String
ID of the audio file to be shown in status (e.g., '1_190442705').
#target_ids ⇒ Array
IDs of communities and user whose statuses will be included in the broadcast.

Instance Method Summary collapse

#initialize(arguments) ⇒ Audio::Methods::SetBroadcast constructor

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ `Audio::Methods::SetBroadcast`

Parameters:

arguments (Hash)

Options Hash (arguments):

:audio (String) —
ID of the audio file to be shown in status (e.g., '1_190442705'). If the parameter is not set, the audio status of given communities and user will be deleted.
:target_ids (Array) —
IDs of communities and user whose statuses will be included in the broadcast. Use a negative value to designate a community ID. By default, current user ID.

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

Instance Method Details

#audio ⇒ `String`

Returns ID of the audio file to be shown in status (e.g., '1_190442705'). If the parameter is not set, the audio status of given communities and user will be deleted.

Returns:

(String) —
ID of the audio file to be shown in status (e.g., '1_190442705'). If the parameter is not set, the audio status of given communities and user will be deleted.

24	# File 'lib/vk/api/audio/methods/set_broadcast.rb', line 24 attribute :audio, API::Types::Coercible::String.optional.default(nil)

#target_ids ⇒ `Array`

Returns IDs of communities and user whose statuses will be included in the broadcast. Use a negative value to designate a community ID. By default, current user ID.