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

Class PhotosGetAlbumsQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<PhotosGetAlbumsQuery,GetAlbumsResponse>

com.vk.api.sdk.queries.photos.PhotosGetAlbumsQuery

public class PhotosGetAlbumsQuery
extends AbstractQueryBuilder<PhotosGetAlbumsQuery,GetAlbumsResponse>

Query for Photos.getAlbums method

Constructor Summary

Constructors

Constructor	Description
PhotosGetAlbumsQuery(VkApiClient client, ServiceActor actor)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
PhotosGetAlbumsQuery(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
PhotosGetAlbumsQuery	albumIds(java.lang.Integer... value)	album_ids Album IDs.
PhotosGetAlbumsQuery	albumIds(java.util.List<java.lang.Integer> value)	Album IDs.
PhotosGetAlbumsQuery	count(java.lang.Integer value)	Number of albums to return.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected PhotosGetAlbumsQuery	getThis()	Get reference to this object
PhotosGetAlbumsQuery	needCovers(java.lang.Boolean value)	'1' — to return an additional 'thumb_src' field, '0' — (default)
PhotosGetAlbumsQuery	needSystem(java.lang.Boolean value)	'1' — to return system albums with negative IDs
PhotosGetAlbumsQuery	offset(java.lang.Integer value)	Offset needed to return a specific subset of albums.
PhotosGetAlbumsQuery	ownerId(java.lang.Integer value)	ID of the user or community that owns the albums.
PhotosGetAlbumsQuery	photoSizes(java.lang.Boolean value)	'1' — to return photo sizes in a

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

PhotosGetAlbumsQuery

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

PhotosGetAlbumsQuery

public PhotosGetAlbumsQuery(VkApiClient client,
                            ServiceActor 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

ownerId

public PhotosGetAlbumsQuery ownerId(java.lang.Integer value)

ID of the user or community that owns the albums.

Parameters:

value - value of "owner id" parameter.

Returns:

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

offset

public PhotosGetAlbumsQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of albums.

Parameters:

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

Returns:

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

count

public PhotosGetAlbumsQuery count(java.lang.Integer value)

Number of albums to return.

Parameters:

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

Returns:

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

needSystem

public PhotosGetAlbumsQuery needSystem(java.lang.Boolean value)

'1' — to return system albums with negative IDs

Parameters:

value - value of "need system" parameter.

Returns:

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

needCovers

public PhotosGetAlbumsQuery needCovers(java.lang.Boolean value)

'1' — to return an additional 'thumb_src' field, '0' — (default)

Parameters:

value - value of "need covers" parameter.

Returns:

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

photoSizes

public PhotosGetAlbumsQuery photoSizes(java.lang.Boolean value)

'1' — to return photo sizes in a

Parameters:

value - value of "photo sizes" parameter.

Returns:

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

albumIds

public PhotosGetAlbumsQuery albumIds(java.lang.Integer... value)

album_ids Album IDs.

Parameters:

value - value of "album ids" parameter.

Returns:

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

albumIds

public PhotosGetAlbumsQuery albumIds(java.util.List<java.lang.Integer> value)

Album IDs.

Parameters:

value - value of "album ids" parameter.

Returns:

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

getThis

protected PhotosGetAlbumsQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<PhotosGetAlbumsQuery,GetAlbumsResponse>

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<PhotosGetAlbumsQuery,GetAlbumsResponse>

Returns:

list of names