com.vk.api.sdk.queries.photos

Class PhotosGetCommentsQuery

java.lang.Object

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

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

com.vk.api.sdk.queries.photos.PhotosGetCommentsQuery

public class PhotosGetCommentsQuery
extends AbstractQueryBuilder<PhotosGetCommentsQuery,GetCommentsResponse>

Query for Photos.getComments method

Constructor Summary

Constructors

Constructor and Description
PhotosGetCommentsQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
PhotosGetCommentsQuery(VkApiClient client, UserActor actor, java.lang.Integer photoId) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
PhotosGetCommentsQuery	accessKey(java.lang.String value) Set access key
PhotosGetCommentsQuery	count(java.lang.Integer value) Number of comments to return.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
PhotosGetCommentsQuery	extended(java.lang.Boolean value) Set extended
PhotosGetCommentsQuery	fields(Fields... value) fields Set fields
PhotosGetCommentsQuery	fields(java.util.List<Fields> value) Set fields
protected PhotosGetCommentsQuery	getThis() Get reference to this object
PhotosGetCommentsQuery	needLikes(java.lang.Boolean value) '1' - to return an additional 'likes' field, '0' - (default)
PhotosGetCommentsQuery	offset(java.lang.Integer value) Offset needed to return a specific subset of comments.
PhotosGetCommentsQuery	ownerId(java.lang.Long value) ID of the user or community that owns the photo.
PhotosGetCommentsQuery	photoId(java.lang.Integer value) Photo ID.
PhotosGetCommentsQuery	sort(GetCommentsSort value) Sort order: 'asc' - old first, 'desc' - new first
PhotosGetCommentsQuery	startCommentId(java.lang.Integer value) Set start comment id

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

PhotosGetCommentsQuery

public PhotosGetCommentsQuery(VkApiClient client,
                              UserActor actor,
                              java.lang.Integer photoId)

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

photoId - value of "photo id" parameter.

PhotosGetCommentsQuery

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

Method Detail

ownerId

public PhotosGetCommentsQuery ownerId(java.lang.Long value)

ID of the user or community that owns the photo.

Parameters:

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

Returns:

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

photoId

public PhotosGetCommentsQuery photoId(java.lang.Integer value)

Photo ID.

Parameters:

value - value of "photo id" parameter.

Returns:

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

needLikes

public PhotosGetCommentsQuery needLikes(java.lang.Boolean value)

'1' - to return an additional 'likes' field, '0' - (default)

Parameters:

value - value of "need likes" parameter.

Returns:

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

startCommentId

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

Offset needed to return a specific subset of comments. By default, '0'.

Parameters:

value - value of "offset" parameter.

Returns:

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

count

public PhotosGetCommentsQuery 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.

sort

public PhotosGetCommentsQuery sort(GetCommentsSort value)

Sort order: 'asc' - old first, 'desc' - new first

Parameters:

value - value of "sort" parameter.

Returns:

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

accessKey

public PhotosGetCommentsQuery accessKey(java.lang.String value)

Set access key

Parameters:

value - value of "access key" parameter.

Returns:

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

extended

public PhotosGetCommentsQuery 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.

fields

public PhotosGetCommentsQuery fields(Fields... value)

fields Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

public PhotosGetCommentsQuery fields(java.util.List<Fields> value)

Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected PhotosGetCommentsQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

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

Returns:

list of names