com.vk.api.sdk.queries.wall

Class WallGetCommentsQuery

java.lang.Object

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

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

com.vk.api.sdk.queries.wall.WallGetCommentsQuery

public class WallGetCommentsQuery
extends AbstractQueryBuilder<WallGetCommentsQuery,GetCommentsResponse>

Query for Wall.getComments method

Constructor Summary

Constructors

Constructor and Description
WallGetCommentsQuery(VkApiClient client, ServiceActor actor) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
WallGetCommentsQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
WallGetCommentsQuery	commentId(java.lang.Integer value) Comment ID.
WallGetCommentsQuery	count(java.lang.Integer value) Number of comments to return (maximum 100).
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
WallGetCommentsQuery	extended(java.lang.Boolean value) Set extended
WallGetCommentsQuery	fields(java.util.List<UserGroupFields> value) Set fields
WallGetCommentsQuery	fields(UserGroupFields... value) fields Set fields
protected WallGetCommentsQuery	getThis() Get reference to this object
WallGetCommentsQuery	needLikes(java.lang.Boolean value) '1' - to return the 'likes' field, '0' - not to return the 'likes' field (default)
WallGetCommentsQuery	offset(java.lang.Integer value) Offset needed to return a specific subset of comments.
WallGetCommentsQuery	ownerId(java.lang.Long value) User ID or community ID.
WallGetCommentsQuery	postId(java.lang.Integer value) Post ID.
WallGetCommentsQuery	previewLength(java.lang.Integer value) Number of characters at which to truncate comments when previewed.
WallGetCommentsQuery	sort(GetCommentsSort value) Sort order: 'asc' - chronological, 'desc' - reverse chronological
WallGetCommentsQuery	startCommentId(java.lang.Integer value) Set start comment id
WallGetCommentsQuery	threadItemsCount(java.lang.Integer value) Count items in threads.

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

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

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

addHeader, addHeaders, execute, executeAsRaw, executeAsString, executeAsStringWithReturningFullInfo, executeTypeable, executeTypeableWithoutRetry, executeWithoutRetry, getClient, getCookie, getGson, getHeaders, getResponseClass, getUrl, setCookie, setCookies, setHeaders, setHeaders

Methods inherited from class java.lang.Object

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

Constructor Detail

WallGetCommentsQuery

public WallGetCommentsQuery(VkApiClient client,
                            UserActor actor)

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

Parameters:

client - VK API client

actor - actor with access token

WallGetCommentsQuery

public WallGetCommentsQuery(VkApiClient client,
                            ServiceActor actor)

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

Parameters:

client - VK API client

actor - actor with access token

Method Detail

ownerId

public WallGetCommentsQuery ownerId(java.lang.Long value)

User ID or community ID. Use a negative value to designate a community ID.

Parameters:

value - value of "owner id" parameter. Entity - owner

Returns:

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

postId

public WallGetCommentsQuery postId(java.lang.Integer value)

Post ID.

Parameters:

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

Returns:

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

needLikes

public WallGetCommentsQuery 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 WallGetCommentsQuery 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 WallGetCommentsQuery 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 WallGetCommentsQuery count(java.lang.Integer value)

Number of comments to return (maximum 100).

Parameters:

value - value of "count" parameter. Minimum is 0.

Returns:

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

sort

public WallGetCommentsQuery sort(GetCommentsSort value)

Sort order: 'asc' - chronological, 'desc' - reverse chronological

Parameters:

value - value of "sort" parameter.

Returns:

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

previewLength

public WallGetCommentsQuery previewLength(java.lang.Integer value)

Number of characters at which to truncate comments when previewed. By default, '90'. Specify '0' if you do not want to truncate comments.

Parameters:

value - value of "preview length" parameter. Minimum is 0.

Returns:

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

extended

public WallGetCommentsQuery extended(java.lang.Boolean value)

Set extended

Parameters:

value - value of "extended" parameter.

Returns:

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

commentId

public WallGetCommentsQuery commentId(java.lang.Integer value)

Comment ID.

Parameters:

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

Returns:

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

threadItemsCount

public WallGetCommentsQuery threadItemsCount(java.lang.Integer value)

Count items in threads.

Parameters:

value - value of "thread items count" parameter. Maximum is 10. Minimum is 0. By default 0.

Returns:

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

fields

public WallGetCommentsQuery fields(UserGroupFields... value)

fields Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

public WallGetCommentsQuery fields(java.util.List<UserGroupFields> value)

Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected WallGetCommentsQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<WallGetCommentsQuery,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<WallGetCommentsQuery,GetCommentsResponse>

Returns:

list of names