Class: Vk::API::Board::Methods::EditComment

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

Overview

Edits a comment on a topic on a community's discussion board.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :group_id (Integer)

    ID of the community that owns the discussion board.

  • :topic_id (Integer)

    Topic ID.

  • :comment_id (Integer)

    ID of the comment on the topic.

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

    . New comment text.

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

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


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

Instance Method Details

#attachmentsArray

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

Returns:

  • (Array)

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


35
# File 'lib/vk/api/board/methods/edit_comment.rb', line 35

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

#comment_idInteger

Returns ID of the comment on the topic.

Returns:

  • (Integer)

    ID of the comment on the topic.


31
# File 'lib/vk/api/board/methods/edit_comment.rb', line 31

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

#group_idInteger

Returns ID of the community that owns the discussion board.

Returns:

  • (Integer)

    ID of the community that owns the discussion board.


27
# File 'lib/vk/api/board/methods/edit_comment.rb', line 27

attribute :group_id, API::Types::Coercible::Int

#messageString

Returns (Required if 'attachments' is not set). New comment text.

Returns:

  • (String)

    (Required if 'attachments' is not set). New comment text.


33
# File 'lib/vk/api/board/methods/edit_comment.rb', line 33

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

#topic_idInteger

Returns Topic ID.

Returns:

  • (Integer)

    Topic ID.


29
# File 'lib/vk/api/board/methods/edit_comment.rb', line 29

attribute :topic_id, API::Types::Coercible::Int