Class: Vk::API::Photos::Methods::EditAlbum

Inherits:

Schema::Method

• Object
• Dry::Struct
• Schema::Method
• Vk::API::Photos::Methods::EditAlbum

Defined in:

lib/vk/api/photos/methods/edit_album.rb

Overview

Edits information about a photo album.

Arguments

• #album_id ⇒ Integer

  ID of the photo album to be edited.

• #comments_disabled ⇒ Boolean
• #description ⇒ String

  New album description.

• #owner_id ⇒ Integer

  ID of the user or community that owns the album.

• #privacy_comment ⇒ Array
• #privacy_view ⇒ Array
• #title ⇒ String

  New album title.

• #upload_by_admins_only ⇒ Boolean

Instance Method Summary

• #initialize(arguments) ⇒ Photos::Methods::EditAlbum constructor

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :album_id (Integer) —

  ID of the photo album to be edited.

• :title (String) —

  New album title.

• :description (String) —

  New album description.

• :owner_id (Integer) —

  ID of the user or community that owns the album.

• :privacy_view (Array) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

• :privacy_comment (Array) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

• :upload_by_admins_only (Boolean) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

• :comments_disabled (Boolean) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

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

Instance Method Details

#album_id ⇒ Integer

Returns ID of the photo album to be edited.

Returns:

• (Integer) —

  ID of the photo album to be edited.

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

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

#comments_disabled ⇒ Boolean

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:

• (Boolean) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

# File 'lib/vk/api/photos/methods/edit_album.rb', line 44

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

#description ⇒ String

Returns New album description.

Returns:

• (String) —

  New album description.

# File 'lib/vk/api/photos/methods/edit_album.rb', line 34

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

#owner_id ⇒ Integer

Returns ID of the user or community that owns the album.

Returns:

• (Integer) —

  ID of the user or community that owns the album.

# File 'lib/vk/api/photos/methods/edit_album.rb', line 36

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

#privacy_comment ⇒ Array

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:

• (Array) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

# File 'lib/vk/api/photos/methods/edit_album.rb', line 40

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

#privacy_view ⇒ Array

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:

• (Array) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

# File 'lib/vk/api/photos/methods/edit_album.rb', line 38

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

#title ⇒ String

Returns New album title.

Returns:

• (String) —

  New album title.

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

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

#upload_by_admins_only ⇒ Boolean

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:

• (Boolean) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

# File 'lib/vk/api/photos/methods/edit_album.rb', line 42

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