Class: Vk::API::Photos::Methods::Edit

Inherits:

Schema::Method

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

Defined in:

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

Overview

Edits the caption of a photo.

Arguments

• #caption ⇒ String

  New caption for the photo.

• #delete_place ⇒ Boolean
• #foursquare_id ⇒ String
• #latitude ⇒ Number
• #longitude ⇒ Number
• #owner_id ⇒ Integer

  ID of the user or community that owns the photo.

• #photo_id ⇒ Integer

  Photo ID.

• #place_str ⇒ String

Instance Method Summary

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

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :owner_id (Integer) —

  ID of the user or community that owns the photo.

• :photo_id (Integer) —

  Photo ID.

• :caption (String) —

  New caption for the photo. If this parameter is not set, it is considered to be equal to an empty string.

• :latitude (Number) —

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

• :longitude (Number) —

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

• :place_str (String) —

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

• :foursquare_id (String) —

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

• :delete_place (Boolean) —

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

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

Instance Method Details

#caption ⇒ String

Returns New caption for the photo. If this parameter is not set, it is considered to be equal to an empty string.

Returns:

• (String) —

  New caption for the photo. If this parameter is not set, it is considered to be equal to an empty string.

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

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

#delete_place ⇒ 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.rb', line 44

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

#foursquare_id ⇒ String

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

Returns:

• (String) —

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

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

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

#latitude ⇒ Number

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

Returns:

• (Number) —

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

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

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

#longitude ⇒ Number

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

Returns:

• (Number) —

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

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

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

#owner_id ⇒ Integer

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

Returns:

• (Integer) —

  ID of the user or community that owns the photo.

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

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

#photo_id ⇒ Integer

Returns Photo ID.

Returns:

• (Integer) —

  Photo ID.

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

attribute :photo_id, API::Types::Coercible::Int

#place_str ⇒ String

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

Returns:

• (String) —

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

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

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