com.vk.api.sdk.queries.photos

Class PhotosGetAllCommentsQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<PhotosGetAllCommentsQuery,GetAllCommentsResponse>

com.vk.api.sdk.queries.photos.PhotosGetAllCommentsQuery

public class PhotosGetAllCommentsQuery
extends AbstractQueryBuilder<PhotosGetAllCommentsQuery,GetAllCommentsResponse>

Query for Photos.getAllComments method

Constructor Summary

Constructors

Constructor and Description
PhotosGetAllCommentsQuery(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
PhotosGetAllCommentsQuery	albumId(java.lang.Integer value) Album ID.
PhotosGetAllCommentsQuery	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 PhotosGetAllCommentsQuery	getThis() Get reference to this object
PhotosGetAllCommentsQuery	needLikes(java.lang.Boolean value) '1' - to return an additional 'likes' field, '0' - (default)
PhotosGetAllCommentsQuery	offset(java.lang.Integer value) Offset needed to return a specific subset of comments.
PhotosGetAllCommentsQuery	ownerId(java.lang.Long value) ID of the user or community that owns the album(s).

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

PhotosGetAllCommentsQuery

public PhotosGetAllCommentsQuery(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 PhotosGetAllCommentsQuery ownerId(java.lang.Long value)

ID of the user or community that owns the album(s).

Parameters:

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

Returns:

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

albumId

public PhotosGetAllCommentsQuery albumId(java.lang.Integer value)

Album ID. If the parameter is not set, comments on all of the user's albums will be returned.

Parameters:

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

Returns:

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

needLikes

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

offset

public PhotosGetAllCommentsQuery offset(java.lang.Integer value)

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

Parameters:

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

Returns:

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

count

public PhotosGetAllCommentsQuery count(java.lang.Integer value)

Number of comments to return. By default, '20'. Maximum value, '100'.

Parameters:

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

Returns:

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

getThis

protected PhotosGetAllCommentsQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<PhotosGetAllCommentsQuery,GetAllCommentsResponse>

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<PhotosGetAllCommentsQuery,GetAllCommentsResponse>

Returns:

list of names