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

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

Overview

Edits information about a photo album.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):


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

Instance Method Details

#album_idInteger

Returns ID of the photo album to be edited.

Returns:

  • (Integer)

    ID of the photo album to be edited.


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

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

#comments_disabledBoolean


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

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

#descriptionString

Returns New album description.

Returns:

  • (String)

    New album description.


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

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

#owner_idInteger

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

Returns:

  • (Integer)

    ID of the user or community that owns the album.


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

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

#privacy_commentArray


40
# 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_viewArray


38
# 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)

#titleString

Returns New album title.

Returns:

  • (String)

    New album title.


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

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

#upload_by_admins_onlyBoolean


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

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