Class: Vk::API::Video::Methods::EditAlbum

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

Overview

Edits the title of a video album.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Video::Methods::EditAlbum

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :group_id (Integer)

    Community ID (if the album edited is owned by a community).

  • :album_id (Integer)

    Album ID.

  • :title (String)

    New album title.

  • :privacy (Array)

    new access permissions for the album.; Possible values: ; *'0' – all users;; *'1' – friends only;; *'2' – friends and friends of friends;; *'3' – "only me".


# File 'lib/vk/api/video/methods/edit_album.rb', line 15

Instance Method Details

#album_idInteger

Returns Album ID.

Returns:

  • (Integer)

    Album ID.


28
# File 'lib/vk/api/video/methods/edit_album.rb', line 28

attribute :album_id, API::Types::Coercible::Int

#group_idInteger

Returns Community ID (if the album edited is owned by a community).

Returns:

  • (Integer)

    Community ID (if the album edited is owned by a community).


26
# File 'lib/vk/api/video/methods/edit_album.rb', line 26

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

#privacyArray

Returns new access permissions for the album.; Possible values: ; *'0' – all users;; *'1' – friends only;; *'2' – friends and friends of friends;; *'3' – "only me".

Returns:

  • (Array)

    new access permissions for the album.; Possible values: ; *'0' – all users;; *'1' – friends only;; *'2' – friends and friends of friends;; *'3' – "only me".


32
# File 'lib/vk/api/video/methods/edit_album.rb', line 32

attribute :privacy, API::Types::Coercible::Array.member(API::Types::Coercible::String).optional.default(nil)

#titleString

Returns New album title.

Returns:

  • (String)

    New album title.


30
# File 'lib/vk/api/video/methods/edit_album.rb', line 30

attribute :title, API::Types::Coercible::String