Package com.vk.api.sdk.queries.board

Class BoardEditCommentQuery

java.lang.Object

com.vk.api.sdk.client.ApiRequest<R>

com.vk.api.sdk.client.AbstractQueryBuilder<BoardEditCommentQuery,OkResponse>

com.vk.api.sdk.queries.board.BoardEditCommentQuery

public class BoardEditCommentQuery
extends AbstractQueryBuilder<BoardEditCommentQuery,OkResponse>

Query for Board.editComment method

Constructor Summary

Constructors

Constructor	Description
BoardEditCommentQuery(VkApiClient client, UserActor actor, int groupId, int topicId, int commentId)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Method Summary

Modifier and Type	Method	Description
BoardEditCommentQuery	attachments(java.lang.String... value)	attachments (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.
BoardEditCommentQuery	attachments(java.util.List<java.lang.String> value)	(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.
protected BoardEditCommentQuery	commentId(int value)	ID of the comment on the topic.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected BoardEditCommentQuery	getThis()	Get reference to this object
protected BoardEditCommentQuery	groupId(int value)	ID of the community that owns the discussion board.
BoardEditCommentQuery	message(java.lang.String value)	(Required if 'attachments' is not set).
protected BoardEditCommentQuery	topicId(int value)	Topic ID.

Methods inherited from class com.vk.api.sdk.client.AbstractQueryBuilder

accessToken, build, captchaKey, captchaSid, clientSecret, confirm, getBody, getMethod, getParams, lang, toString, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, version

Methods inherited from class com.vk.api.sdk.client.ApiRequest

execute, executeAsRaw, executeAsString, getClient, getGson, getHeaders, getResponseClass, getUrl, setHeaders

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BoardEditCommentQuery

public BoardEditCommentQuery(VkApiClient client,
                             UserActor actor,
                             int groupId,
                             int topicId,
                             int commentId)

Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

groupId - value of "group id" parameter. Minimum is 1.

topicId - value of "topic id" parameter. Minimum is 0.

commentId - value of "comment id" parameter. Minimum is 0.

Method Detail

groupId

protected BoardEditCommentQuery groupId(int value)

ID of the community that owns the discussion board.

Parameters:

value - value of "group id" parameter. Minimum is 1.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

topicId

protected BoardEditCommentQuery topicId(int value)

Topic ID.

Parameters:

value - value of "topic id" parameter. Minimum is 0.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

commentId

protected BoardEditCommentQuery commentId(int value)

ID of the comment on the topic.

Parameters:

value - value of "comment id" parameter. Minimum is 0.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

message

public BoardEditCommentQuery message(java.lang.String value)

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

Parameters:

value - value of "message" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

attachments

public BoardEditCommentQuery attachments(java.lang.String... value)

attachments (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"

Parameters:

value - value of "attachments" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

attachments

public BoardEditCommentQuery attachments(java.util.List<java.lang.String> value)

(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"

Parameters:

value - value of "attachments" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

getThis

protected BoardEditCommentQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<BoardEditCommentQuery,OkResponse>

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

essentialKeys

protected java.util.List<java.lang.String> essentialKeys()

Description copied from class: AbstractQueryBuilder

Get list of required parameter names

Specified by:

essentialKeys in class AbstractQueryBuilder<BoardEditCommentQuery,OkResponse>

Returns:

list of names