com.vk.api.sdk.queries.photos

Class PhotosGetByIdQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<PhotosGetByIdQuery,java.util.List<GetByIdResponse>>

com.vk.api.sdk.queries.photos.PhotosGetByIdQuery

public class PhotosGetByIdQuery
extends AbstractQueryBuilder<PhotosGetByIdQuery,java.util.List<GetByIdResponse>>

Query for Photos.getById method

Constructor Summary

Constructors

Constructor and Description
PhotosGetByIdQuery(VkApiClient client, ServiceActor actor) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
PhotosGetByIdQuery(VkApiClient client, ServiceActor actor, java.util.List<java.lang.String> photos) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
PhotosGetByIdQuery(VkApiClient client, ServiceActor actor, java.lang.String... photos) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
PhotosGetByIdQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
PhotosGetByIdQuery(VkApiClient client, UserActor actor, java.util.List<java.lang.String> photos) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
PhotosGetByIdQuery(VkApiClient client, UserActor actor, java.lang.String... photos) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
PhotosGetByIdQuery	extended(java.lang.Boolean value) '1' - to return additional fields, '0' - (default)
protected PhotosGetByIdQuery	getThis() Get reference to this object
PhotosGetByIdQuery	photos(java.util.List<java.lang.String> value) IDs separated with a comma, that are IDs of users who posted photos and IDs of photos themselves with an underscore character between such IDs.
PhotosGetByIdQuery	photos(java.lang.String... value) photos IDs separated with a comma, that are IDs of users who posted photos and IDs of photos themselves with an underscore character between such IDs.
PhotosGetByIdQuery	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, 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

PhotosGetByIdQuery

public PhotosGetByIdQuery(VkApiClient client,
                          UserActor actor,
                          java.lang.String... photos)

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

photos - value of "photos" parameter.

PhotosGetByIdQuery

public PhotosGetByIdQuery(VkApiClient client,
                          UserActor actor,
                          java.util.List<java.lang.String> photos)

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

photos - value of "photos" parameter.

PhotosGetByIdQuery

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

PhotosGetByIdQuery

public PhotosGetByIdQuery(VkApiClient client,
                          ServiceActor actor,
                          java.lang.String... photos)

Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

photos - value of "photos" parameter.

PhotosGetByIdQuery

public PhotosGetByIdQuery(VkApiClient client,
                          ServiceActor actor,
                          java.util.List<java.lang.String> photos)

Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

photos - value of "photos" parameter.

PhotosGetByIdQuery

public PhotosGetByIdQuery(VkApiClient client,
                          ServiceActor actor)

Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

Method Detail

extended

public PhotosGetByIdQuery extended(java.lang.Boolean value)

'1' - to return additional fields, '0' - (default)

Parameters:

value - value of "extended" parameter.

Returns:

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

photoSizes

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

photos

public PhotosGetByIdQuery photos(java.lang.String... value)

photos IDs separated with a comma, that are IDs of users who posted photos and IDs of photos themselves with an underscore character between such IDs. To get information about a photo in the group album, you shall specify group ID instead of user ID. Example: "1_129207899,6492_135055734, , -20629724_271945303"

Parameters:

value - value of "photos" parameter.

Returns:

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

photos

public PhotosGetByIdQuery photos(java.util.List<java.lang.String> value)

IDs separated with a comma, that are IDs of users who posted photos and IDs of photos themselves with an underscore character between such IDs. To get information about a photo in the group album, you shall specify group ID instead of user ID. Example: "1_129207899,6492_135055734, , -20629724_271945303"

Parameters:

value - value of "photos" parameter.

Returns:

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

getThis

protected PhotosGetByIdQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<PhotosGetByIdQuery,java.util.List<GetByIdResponse>>

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<PhotosGetByIdQuery,java.util.List<GetByIdResponse>>

Returns:

list of names