com.vk.api.sdk.queries.photos

Class PhotosSaveQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<PhotosSaveQuery,java.util.List<SaveResponse>>

com.vk.api.sdk.queries.photos.PhotosSaveQuery

public class PhotosSaveQuery
extends AbstractQueryBuilder<PhotosSaveQuery,java.util.List<SaveResponse>>

Query for Photos.save method

Constructor Summary

Constructors

Constructor and Description
PhotosSaveQuery(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
PhotosSaveQuery	albumId(java.lang.Integer value) ID of the album to save photos to.
PhotosSaveQuery	caption(java.lang.String value) Text describing the photo. 2048 digits max.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected PhotosSaveQuery	getThis() Get reference to this object
PhotosSaveQuery	groupId(java.lang.Long value) ID of the community to save photos to.
PhotosSaveQuery	hash(java.lang.String value) Parameter returned when photos are [vk.com/dev/upload_files|uploaded to server].
PhotosSaveQuery	latitude(java.lang.Number value) Geographical latitude, in degrees (from '-90' to '90').
PhotosSaveQuery	longitude(java.lang.Number value) Geographical longitude, in degrees (from '-180' to '180').
PhotosSaveQuery	photosList(java.lang.String value) Parameter returned when photos are [vk.com/dev/upload_files|uploaded to server].
PhotosSaveQuery	server(java.lang.Integer value) Parameter returned when photos are [vk.com/dev/upload_files|uploaded to server].

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

PhotosSaveQuery

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

albumId

public PhotosSaveQuery albumId(java.lang.Integer value)

ID of the album to save photos to.

Parameters:

value - value of "album id" parameter.

Returns:

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

groupId

public PhotosSaveQuery groupId(java.lang.Long value)

ID of the community to save photos to.

Parameters:

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

Returns:

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

server

public PhotosSaveQuery server(java.lang.Integer value)

Parameter returned when photos are [vk.com/dev/upload_files|uploaded to server].

Parameters:

value - value of "server" parameter.

Returns:

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

photosList

public PhotosSaveQuery photosList(java.lang.String value)

Parameter returned when photos are [vk.com/dev/upload_files|uploaded to server].

Parameters:

value - value of "photos list" parameter.

Returns:

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

hash

public PhotosSaveQuery hash(java.lang.String value)

Parameter returned when photos are [vk.com/dev/upload_files|uploaded to server].

Parameters:

value - value of "hash" parameter.

Returns:

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

latitude

public PhotosSaveQuery latitude(java.lang.Number value)

Geographical latitude, in degrees (from '-90' to '90').

Parameters:

value - value of "latitude" parameter.

Returns:

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

longitude

public PhotosSaveQuery longitude(java.lang.Number value)

Geographical longitude, in degrees (from '-180' to '180').

Parameters:

value - value of "longitude" parameter.

Returns:

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

caption

public PhotosSaveQuery caption(java.lang.String value)

Text describing the photo. 2048 digits max.

Parameters:

value - value of "caption" parameter.

Returns:

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

getThis

protected PhotosSaveQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<PhotosSaveQuery,java.util.List<SaveResponse>>

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<PhotosSaveQuery,java.util.List<SaveResponse>>

Returns:

list of names