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

Class BoardGetCommentsQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<BoardGetCommentsQuery,GetCommentsResponse>

com.vk.api.sdk.queries.board.BoardGetCommentsQuery

public class BoardGetCommentsQuery
extends AbstractQueryBuilder<BoardGetCommentsQuery,GetCommentsResponse>

Query for Board.getComments method

Constructor Summary

Constructors

Constructor	Description
BoardGetCommentsQuery(VkApiClient client, ServiceActor actor, int groupId, int topicId)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
BoardGetCommentsQuery(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
BoardGetCommentsQuery	count(java.lang.Integer value)	Number of comments to return.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
BoardGetCommentsQuery	extended(java.lang.Boolean value)	'1' — to return information about users who posted comments, '0' — to return no additional fields (default)
protected BoardGetCommentsQuery	getThis()	Get reference to this object
protected BoardGetCommentsQuery	groupId(int value)	ID of the community that owns the discussion board.
BoardGetCommentsQuery	needLikes(java.lang.Boolean value)	'1' — to return the 'likes' field, '0' — not to return the 'likes' field (default)
BoardGetCommentsQuery	offset(java.lang.Integer value)	Offset needed to return a specific subset of comments.
BoardGetCommentsQuery	sort(GetCommentsSort value)	Sort order: 'asc' — by creation date in chronological order, 'desc' — by creation date in reverse chronological order,
BoardGetCommentsQuery	startCommentId(java.lang.Integer value)	Set start comment id
protected BoardGetCommentsQuery	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

BoardGetCommentsQuery

public BoardGetCommentsQuery(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.

BoardGetCommentsQuery

public BoardGetCommentsQuery(VkApiClient client,
                             ServiceActor 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 BoardGetCommentsQuery 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 BoardGetCommentsQuery 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.

needLikes

public BoardGetCommentsQuery needLikes(java.lang.Boolean value)

'1' — to return the 'likes' field, '0' — not to return the 'likes' field (default)

Parameters:

value - value of "need likes" parameter.

Returns:

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

startCommentId

public BoardGetCommentsQuery startCommentId(java.lang.Integer value)

Set start comment id

Parameters:

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

Returns:

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

offset

public BoardGetCommentsQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of comments.

Parameters:

value - value of "offset" parameter.

Returns:

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

count

public BoardGetCommentsQuery count(java.lang.Integer value)

Number of comments to return.

Parameters:

value - value of "count" parameter. Maximum is 100. Minimum is 0. By default 20.

Returns:

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

extended

public BoardGetCommentsQuery extended(java.lang.Boolean value)

'1' — to return information about users who posted comments, '0' — to return no additional fields (default)

Parameters:

value - value of "extended" parameter.

Returns:

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

sort

public BoardGetCommentsQuery sort(GetCommentsSort value)

Sort order: 'asc' — by creation date in chronological order, 'desc' — by creation date in reverse chronological order,

Parameters:

value - value of "sort" parameter.

Returns:

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

getThis

protected BoardGetCommentsQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<BoardGetCommentsQuery,GetCommentsResponse>

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<BoardGetCommentsQuery,GetCommentsResponse>

Returns:

list of names