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

Class BoardCreateCommentQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<BoardCreateCommentQuery,java.lang.Integer>

com.vk.api.sdk.queries.board.BoardCreateCommentQuery

public class BoardCreateCommentQuery
extends AbstractQueryBuilder<BoardCreateCommentQuery,java.lang.Integer>

Query for Board.createComment method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
BoardCreateCommentQuery	attachments(java.lang.String... value)	attachments (Required if 'text' 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.
BoardCreateCommentQuery	attachments(java.util.List<java.lang.String> value)	(Required if 'text' 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 java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
BoardCreateCommentQuery	fromGroup(java.lang.Boolean value)	'1' — to post the comment as by the community, '0' — to post the comment as by the user (default)
protected BoardCreateCommentQuery	getThis()	Get reference to this object
protected BoardCreateCommentQuery	groupId(int value)	ID of the community that owns the discussion board.
BoardCreateCommentQuery	guid(java.lang.String value)	Unique identifier to avoid repeated comments.
BoardCreateCommentQuery	message(java.lang.String value)	(Required if 'attachments' is not set.) Text of the comment.
BoardCreateCommentQuery	stickerId(java.lang.Integer value)	Sticker ID.
protected BoardCreateCommentQuery	topicId(int value)	ID of the topic to be commented on.

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

BoardCreateCommentQuery

public BoardCreateCommentQuery(VkApiClient client,
                               UserActor actor,
                               int groupId,
                               int topicId)

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.

Method Detail

groupId

protected BoardCreateCommentQuery 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 BoardCreateCommentQuery topicId(int value)

ID of the topic to be commented on.

Parameters:

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

Returns:

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

message

public BoardCreateCommentQuery message(java.lang.String value)

(Required if 'attachments' is not set.) Text of the comment.

Parameters:

value - value of "message" parameter.

Returns:

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

fromGroup

public BoardCreateCommentQuery fromGroup(java.lang.Boolean value)

'1' — to post the comment as by the community, '0' — to post the comment as by the user (default)

Parameters:

value - value of "from group" parameter.

Returns:

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

stickerId

public BoardCreateCommentQuery stickerId(java.lang.Integer value)

Sticker ID.

Parameters:

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

Returns:

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

guid

public BoardCreateCommentQuery guid(java.lang.String value)

Unique identifier to avoid repeated comments.

Parameters:

value - value of "guid" parameter.

Returns:

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

attachments

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

attachments (Required if 'text' 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.

Parameters:

value - value of "attachments" parameter.

Returns:

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

attachments

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

(Required if 'text' 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.

Parameters:

value - value of "attachments" parameter.

Returns:

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

getThis

protected BoardCreateCommentQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<BoardCreateCommentQuery,java.lang.Integer>

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<BoardCreateCommentQuery,java.lang.Integer>

Returns:

list of names