Class: Vk::API::Video::Methods::EditComment

Inherits:

Schema::Method

• Object
• Dry::Struct
• Schema::Method
• Vk::API::Video::Methods::EditComment

Defined in:

lib/vk/api/video/methods/edit_comment.rb

Overview

Edits the text of a comment on a video.

Arguments

• #attachments ⇒ Array

  List of objects attached to the comment, in the following format:; "<owner_id><media_id>,<owner_id><media_id>"; '' — Type of media attachment:; 'photo' — photo; 'video' — video; 'audio' — audio; 'doc' — document; '<owner_id>' — ID of the media attachment owner.; '<media_id>' — Media attachment ID.

• #comment_id ⇒ Integer

  Comment ID.

• #message ⇒ String

  New comment text.

• #owner_id ⇒ Integer

  ID of the user or community that owns the video.

Instance Method Summary

• #initialize(arguments) ⇒ Video::Methods::EditComment constructor

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :owner_id (Integer) —

  ID of the user or community that owns the video.

• :comment_id (Integer) —

  Comment ID.

• :message (String) —

  New comment text.

• :attachments (Array) —

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

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

Instance Method Details

#attachments ⇒ Array

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

Returns:

• (Array) —

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

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

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

#comment_id ⇒ Integer

Returns Comment ID.

Returns:

• (Integer) —

  Comment ID.

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

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

#message ⇒ String

Returns New comment text.

Returns:

• (String) —

  New comment text.

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

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

#owner_id ⇒ Integer

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

Returns:

• (Integer) —

  ID of the user or community that owns the video.

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

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