Class: Vk::API::Audio::Methods::Edit

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

Overview

Edits an audio file on a user or community page.;

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :owner_id (Integer)

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

  • :audio_id (Integer)

    Audio file ID.

  • :artist (String)

    Name of the artist.

  • :title (String)

    Title of the audio file.

  • :text (String)

    Text of the lyrics of the audio file.

  • :genre_id (Integer)

    Genre of the audio file. See the list of .

  • :no_search (Boolean)

    '1' — audio file will not be available for search; '0' — audio file will be available for search (default)


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


Instance Method Details

#artistString

Returns Name of the artist.

Returns:

  • (String)

    Name of the artist.


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

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

#audio_idInteger

Returns Audio file ID.

Returns:

  • (Integer)

    Audio file ID.


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

attribute :audio_id, API::Types::Coercible::Int

#genre_idInteger

Returns Genre of the audio file. See the list of .

Returns:

  • (Integer)

    Genre of the audio file. See the list of .


39
# File 'lib/vk/api/audio/methods/edit.rb', line 39

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

#no_searchBoolean

Returns '1' — audio file will not be available for search; '0' — audio file will be available for search (default).

Returns:

  • (Boolean)

    '1' — audio file will not be available for search; '0' — audio file will be available for search (default)


41
# File 'lib/vk/api/audio/methods/edit.rb', line 41

attribute :no_search, API::Types::Form::Bool.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.


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

attribute :owner_id, API::Types::Coercible::Int

#textString

Returns Text of the lyrics of the audio file.

Returns:

  • (String)

    Text of the lyrics of the audio file.


37
# File 'lib/vk/api/audio/methods/edit.rb', line 37

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

#titleString

Returns Title of the audio file.

Returns:

  • (String)

    Title of the audio file.


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

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