Package com.vk.api.sdk.queries.photos

Class PhotosGetUserPhotosQueryWithExtended

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<PhotosGetUserPhotosQueryWithExtended,GetUserPhotosExtendedResponse>

com.vk.api.sdk.queries.photos.PhotosGetUserPhotosQueryWithExtended

public class PhotosGetUserPhotosQueryWithExtended
extends AbstractQueryBuilder<PhotosGetUserPhotosQueryWithExtended,GetUserPhotosExtendedResponse>

Query for Photos.getUserPhotos method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
PhotosGetUserPhotosQueryWithExtended	count(java.lang.Integer value)	Number of photos to return.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected PhotosGetUserPhotosQueryWithExtended	extended(java.lang.Boolean value)	'1' — to return an additional 'likes' field, '0' — (default)
protected PhotosGetUserPhotosQueryWithExtended	getThis()	Get reference to this object
PhotosGetUserPhotosQueryWithExtended	offset(java.lang.Integer value)	Offset needed to return a specific subset of photos.
PhotosGetUserPhotosQueryWithExtended	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
PhotosGetUserPhotosQueryWithExtended	userId(java.lang.Integer value)	User 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

PhotosGetUserPhotosQueryWithExtended

public PhotosGetUserPhotosQueryWithExtended(VkApiClient client,
                                            UserActor actor)

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

Method Detail

userId

public PhotosGetUserPhotosQueryWithExtended userId(java.lang.Integer value)

User ID.

Parameters:

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

Returns:

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

offset

public PhotosGetUserPhotosQueryWithExtended 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 PhotosGetUserPhotosQueryWithExtended 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

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

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<PhotosGetUserPhotosQueryWithExtended,GetUserPhotosExtendedResponse>

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<PhotosGetUserPhotosQueryWithExtended,GetUserPhotosExtendedResponse>

Returns:

list of names