Class: Vk::API::Video::Methods::CreateComment

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

Overview

Adds a new comment on a video.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :owner_id (Integer) —

    ID of the user or community that owns the video.

  • :video_id (Integer) —

    Video ID.

  • :message (String) —

    New comment text.

  • :attachments (Array) —

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

  • :from_group (Boolean) —

    '1' — to post the comment from a community name (only if 'owner_id'<0)

  • :reply_to_comment (Integer)
  • :sticker_id (Integer) —

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

  • :guid (String) —

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




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

Instance Method Details

#attachments ⇒ Array

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

Returns:

  • (Array) —

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



36
 
# File 'lib/vk/api/video/methods/create_comment.rb', line 36

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

#from_group ⇒ Boolean

Returns '1' — to post the comment from a community name (only if 'owner_id'<0).

Returns:

  • (Boolean) —

    '1' — to post the comment from a community name (only if 'owner_id'<0)



38
 
# File 'lib/vk/api/video/methods/create_comment.rb', line 38

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

#guid ⇒ String

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

Returns:



44
 
# File 'lib/vk/api/video/methods/create_comment.rb', line 44

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

#message ⇒ String

Returns New comment text.

Returns:

  • (String) —

    New comment text.



34
 
# File 'lib/vk/api/video/methods/create_comment.rb', line 34

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.



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

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

#reply_to_comment ⇒ Integer

Returns:

  • (Integer) 


40
 
# File 'lib/vk/api/video/methods/create_comment.rb', line 40

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

#sticker_id ⇒ Integer

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

Returns:



42
 
# File 'lib/vk/api/video/methods/create_comment.rb', line 42

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

#video_id ⇒ Integer

Returns Video ID.

Returns:

  • (Integer) —

    Video ID.



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

attribute :video_id, API::Types::Coercible::Int