Class: Vk::API::Photos::Methods::CreateComment

Inherits:

Schema::Method

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

Defined in:

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

Overview

Adds a new comment on the photo.

Arguments

• #access_key ⇒ String
• #attachments ⇒ 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".

• #from_group ⇒ Boolean

  '1' — to post a comment from the community.

• #guid ⇒ String
• #message ⇒ String

  Comment text.

• #owner_id ⇒ Integer

  ID of the user or community that owns the photo.

• #photo_id ⇒ Integer

  Photo ID.

• #reply_to_comment ⇒ Integer
• #sticker_id ⇒ Integer

Instance Method Summary

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

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :owner_id (Integer) —

  ID of the user or community that owns the photo.

• :photo_id (Integer) —

  Photo ID.

• :message (String) —

  Comment text.

• :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"

• :from_group (Boolean) —

  '1' — to post a comment from the community

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

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

• :access_key (String) —

  @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/photos/methods/create_comment.rb', line 15

Instance Method Details

#access_key ⇒ 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/create_comment.rb', line 45

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

#attachments ⇒ Array

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"

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

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

#from_group ⇒ Boolean

Returns '1' — to post a comment from the community.

Returns:

• (Boolean) —

  '1' — to post a comment from the community

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

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:

• (String) —

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

# File 'lib/vk/api/photos/methods/create_comment.rb', line 47

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

#message ⇒ String

Returns Comment text.

Returns:

• (String) —

  Comment text.

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

attribute :message, API::Types::Coercible::String.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/create_comment.rb', line 31

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/create_comment.rb', line 33

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

#reply_to_comment ⇒ Integer

Returns:

• (Integer)

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

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:

• (Integer) —

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

# File 'lib/vk/api/photos/methods/create_comment.rb', line 43

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