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

Class BoardGetCommentsQueryWithExtended

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<BoardGetCommentsQueryWithExtended,GetCommentsExtendedResponse>

com.vk.api.sdk.queries.board.BoardGetCommentsQueryWithExtended

public class BoardGetCommentsQueryWithExtended
extends AbstractQueryBuilder<BoardGetCommentsQueryWithExtended,GetCommentsExtendedResponse>

Query for Board.getComments method

Constructor Summary

Constructors

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

BoardGetCommentsQueryWithExtended

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

BoardGetCommentsQueryWithExtended

public BoardGetCommentsQueryWithExtended(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 BoardGetCommentsQueryWithExtended 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 BoardGetCommentsQueryWithExtended 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 BoardGetCommentsQueryWithExtended 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 BoardGetCommentsQueryWithExtended 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 BoardGetCommentsQueryWithExtended 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 BoardGetCommentsQueryWithExtended 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

protected BoardGetCommentsQueryWithExtended 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 BoardGetCommentsQueryWithExtended 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 BoardGetCommentsQueryWithExtended getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<BoardGetCommentsQueryWithExtended,GetCommentsExtendedResponse>

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<BoardGetCommentsQueryWithExtended,GetCommentsExtendedResponse>

Returns:

list of names