Class: Vk::API::Photos::Methods::PutTag

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

Overview

Adds a tag on the photo.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :owner_id (Integer) —

    ID of the user or community that owns the photo.

  • :photo_id (Integer) —

    Photo ID.

  • :user_id (Integer) —

    ID of the user to be tagged.

  • :x (Number) —

    Upper left-corner coordinate of the tagged area (as a percentage of the photo's width).

  • :y (Number) —

    Upper left-corner coordinate of the tagged area (as a percentage of the photo's height).

  • :x2 (Number) —

    Lower right-corner coordinate of the tagged area (as a percentage of the photo's width).

  • :y2 (Number) —

    Lower right-corner coordinate of the tagged area (as a percentage of the photo's height).




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

Instance Method Details

#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.



29
 
# File 'lib/vk/api/photos/methods/put_tag.rb', line 29

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

#photo_id ⇒ Integer

Returns Photo ID.

Returns:

  • (Integer) —

    Photo ID.



31
 
# File 'lib/vk/api/photos/methods/put_tag.rb', line 31

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

#user_id ⇒ Integer

Returns ID of the user to be tagged.

Returns:

  • (Integer) —

    ID of the user to be tagged.



33
 
# File 'lib/vk/api/photos/methods/put_tag.rb', line 33

attribute :user_id, API::Types::Coercible::Int

#x ⇒ Number

Returns Upper left-corner coordinate of the tagged area (as a percentage of the photo's width).

Returns:

  • (Number) —

    Upper left-corner coordinate of the tagged area (as a percentage of the photo's width).



35
 
# File 'lib/vk/api/photos/methods/put_tag.rb', line 35

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

#x2 ⇒ Number

Returns Lower right-corner coordinate of the tagged area (as a percentage of the photo's width).

Returns:

  • (Number) —

    Lower right-corner coordinate of the tagged area (as a percentage of the photo's width).



39
 
# File 'lib/vk/api/photos/methods/put_tag.rb', line 39

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

#y ⇒ Number

Returns Upper left-corner coordinate of the tagged area (as a percentage of the photo's height).

Returns:

  • (Number) —

    Upper left-corner coordinate of the tagged area (as a percentage of the photo's height).



37
 
# File 'lib/vk/api/photos/methods/put_tag.rb', line 37

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

#y2 ⇒ Number

Returns Lower right-corner coordinate of the tagged area (as a percentage of the photo's height).

Returns:

  • (Number) —

    Lower right-corner coordinate of the tagged area (as a percentage of the photo's height).



41
 
# File 'lib/vk/api/photos/methods/put_tag.rb', line 41

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