com.vk.api.sdk.queries.photos

Class PhotosGetUserPhotosQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<PhotosGetUserPhotosQuery,GetUserPhotosResponse>

com.vk.api.sdk.queries.photos.PhotosGetUserPhotosQuery

public class PhotosGetUserPhotosQuery
extends AbstractQueryBuilder<PhotosGetUserPhotosQuery,GetUserPhotosResponse>

Query for Photos.getUserPhotos method

Constructor Summary

Constructors

Constructor and Description
PhotosGetUserPhotosQuery(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
PhotosGetUserPhotosQuery	count(java.lang.Integer value) Number of photos to return.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
PhotosGetUserPhotosQuery	extended(java.lang.Boolean value) '1' - to return an additional 'likes' field, '0' - (default)
protected PhotosGetUserPhotosQuery	getThis() Get reference to this object
PhotosGetUserPhotosQuery	offset(java.lang.Integer value) Offset needed to return a specific subset of photos.
PhotosGetUserPhotosQuery	sort(java.lang.String value) Sort order: '1' - by date the tag was added in ascending order, '0' - by date the tag was added in descending order
PhotosGetUserPhotosQuery	userId(java.lang.Long value) User 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

PhotosGetUserPhotosQuery

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

userId

public PhotosGetUserPhotosQuery userId(java.lang.Long value)

User ID.

Parameters:

value - value of "user id" parameter. Minimum is 0. Entity - owner

Returns:

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

offset

public PhotosGetUserPhotosQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of photos. 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 PhotosGetUserPhotosQuery count(java.lang.Integer value)

Number of photos to return. Maximum value is 1000.

Parameters:

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

Returns:

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

extended

public PhotosGetUserPhotosQuery extended(java.lang.Boolean value)

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

Parameters:

value - value of "extended" parameter.

Returns:

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

sort

public PhotosGetUserPhotosQuery sort(java.lang.String value)

Sort order: '1' - by date the tag was added in ascending order, '0' - by date the tag was added in descending order

Parameters:

value - value of "sort" parameter.

Returns:

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

getThis

protected PhotosGetUserPhotosQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<PhotosGetUserPhotosQuery,GetUserPhotosResponse>

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<PhotosGetUserPhotosQuery,GetUserPhotosResponse>

Returns:

list of names