Class: Vk::API::Photos::Methods::EditComment

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

Overview

Edits a comment on a photo.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :owner_id (Integer)

    ID of the user or community that owns the photo.

  • :comment_id (Integer)

    Comment ID.

  • :message (String)

    New text of the comment.

  • :attachments (Array) — default: Required if 'message' is not set.

    List of objects attached to the post, in the following format:; ","; '' — Type of media attachment:; 'photo' — photo; 'video' — video; 'audio' — audio; 'doc' — document; '' — Media attachment owner ID.; '' — Media attachment ID.; ; Example:; "photo100172_166443618,photo66748_265827614"


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

Instance Method Details

#attachmentsArray

Returns (Required if 'message' is not set.) List of objects attached to the post, in the following format:; ","; '' — Type of media attachment:; 'photo' — photo; 'video' — video; 'audio' — audio; 'doc' — document; '' — Media attachment owner ID.; '' — Media attachment ID.; ; Example:; "photo100172_166443618,photo66748_265827614".

Returns:

  • (Array)

    (Required if 'message' is not set.) List of objects attached to the post, in the following format:; ","; '' — Type of media attachment:; 'photo' — photo; 'video' — video; 'audio' — audio; 'doc' — document; '' — Media attachment owner ID.; '' — Media attachment ID.; ; Example:; "photo100172_166443618,photo66748_265827614"


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

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

#comment_idInteger

Returns Comment ID.

Returns:

  • (Integer)

    Comment ID.


28
# File 'lib/vk/api/photos/methods/edit_comment.rb', line 28

attribute :comment_id, API::Types::Coercible::Int

#messageString

Returns New text of the comment.

Returns:

  • (String)

    New text of the comment.


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

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

#owner_idInteger

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

Returns:

  • (Integer)

    ID of the user or community that owns the photo.


26
# File 'lib/vk/api/photos/methods/edit_comment.rb', line 26

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