com.vk.api.sdk.queries.photos

Class PhotosGetAllQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<PhotosGetAllQuery,GetAllResponse>

com.vk.api.sdk.queries.photos.PhotosGetAllQuery

public class PhotosGetAllQuery
extends AbstractQueryBuilder<PhotosGetAllQuery,GetAllResponse>

Query for Photos.getAll method

Constructor Summary

Constructors

Constructor and Description
PhotosGetAllQuery(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
PhotosGetAllQuery	count(java.lang.Integer value) Number of photos to return.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
PhotosGetAllQuery	extended(java.lang.Boolean value) '1' - to return detailed information about photos
protected PhotosGetAllQuery	getThis() Get reference to this object
PhotosGetAllQuery	needHidden(java.lang.Boolean value) '1' - to show information about photos being hidden from the block above the wall.
PhotosGetAllQuery	noServiceAlbums(java.lang.Boolean value) '1' - to return photos only from standard albums, '0' - to return all photos including those in service albums, e.g., 'My wall photos' (default)
PhotosGetAllQuery	offset(java.lang.Integer value) Offset needed to return a specific subset of photos.
PhotosGetAllQuery	ownerId(java.lang.Long value) ID of a user or community that owns the photos.
PhotosGetAllQuery	photoSizes(java.lang.Boolean value) '1' - to return image sizes in [vk.com/dev/photo_sizes|special format].
PhotosGetAllQuery	skipHidden(java.lang.Boolean value) '1' - not to return photos being hidden from the block above the wall.

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

PhotosGetAllQuery

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

ID of a user or community that owns the photos. Use a negative value to designate a community ID.

Parameters:

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

Returns:

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

extended

public PhotosGetAllQuery extended(java.lang.Boolean value)

'1' - to return detailed information about photos

Parameters:

value - value of "extended" parameter.

Returns:

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

offset

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

Number of photos to return.

Parameters:

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

Returns:

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

photoSizes

public PhotosGetAllQuery photoSizes(java.lang.Boolean value)

'1' - to return image sizes in [vk.com/dev/photo_sizes|special format].

Parameters:

value - value of "photo sizes" parameter.

Returns:

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

noServiceAlbums

public PhotosGetAllQuery noServiceAlbums(java.lang.Boolean value)

'1' - to return photos only from standard albums, '0' - to return all photos including those in service albums, e.g., 'My wall photos' (default)

Parameters:

value - value of "no service albums" parameter.

Returns:

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

needHidden

public PhotosGetAllQuery needHidden(java.lang.Boolean value)

'1' - to show information about photos being hidden from the block above the wall.

Parameters:

value - value of "need hidden" parameter.

Returns:

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

skipHidden

public PhotosGetAllQuery skipHidden(java.lang.Boolean value)

'1' - not to return photos being hidden from the block above the wall. Works only with owner_id>0, no_service_albums is ignored.

Parameters:

value - value of "skip hidden" parameter.

Returns:

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

getThis

protected PhotosGetAllQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<PhotosGetAllQuery,GetAllResponse>

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<PhotosGetAllQuery,GetAllResponse>

Returns:

list of names