com.vk.api.sdk.queries.photos

Class PhotosEditQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<PhotosEditQuery,OkResponse>

com.vk.api.sdk.queries.photos.PhotosEditQuery

public class PhotosEditQuery
extends AbstractQueryBuilder<PhotosEditQuery,OkResponse>

Query for Photos.edit method

Constructor Summary

Constructors

Constructor and Description
PhotosEditQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
PhotosEditQuery(VkApiClient client, UserActor actor, java.lang.Integer photoId) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
PhotosEditQuery	caption(java.lang.String value) New caption for the photo.
PhotosEditQuery	deletePlace(java.lang.Boolean value) Set delete place
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
PhotosEditQuery	foursquareId(java.lang.String value) Set foursquare id
protected PhotosEditQuery	getThis() Get reference to this object
PhotosEditQuery	latitude(java.lang.Number value) Set latitude
PhotosEditQuery	longitude(java.lang.Number value) Set longitude
PhotosEditQuery	ownerId(java.lang.Long value) ID of the user or community that owns the photo.
PhotosEditQuery	photoId(java.lang.Integer value) Photo ID.
PhotosEditQuery	placeStr(java.lang.String value) Set place str

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

PhotosEditQuery

public PhotosEditQuery(VkApiClient client,
                       UserActor actor,
                       java.lang.Integer photoId)

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

photoId - value of "photo id" parameter. Minimum is 0.

PhotosEditQuery

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

ID of the user or community that owns the photo.

Parameters:

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

Returns:

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

photoId

public PhotosEditQuery photoId(java.lang.Integer value)

Photo ID.

Parameters:

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

Returns:

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

caption

public PhotosEditQuery caption(java.lang.String value)

New caption for the photo. If this parameter is not set, it is considered to be equal to an empty string.

Parameters:

value - value of "caption" parameter.

Returns:

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

latitude

public PhotosEditQuery latitude(java.lang.Number value)

Set latitude

Parameters:

value - value of "latitude" parameter.

Returns:

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

longitude

public PhotosEditQuery longitude(java.lang.Number value)

Set longitude

Parameters:

value - value of "longitude" parameter.

Returns:

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

placeStr

public PhotosEditQuery placeStr(java.lang.String value)

Set place str

Parameters:

value - value of "place str" parameter.

Returns:

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

foursquareId

public PhotosEditQuery foursquareId(java.lang.String value)

Set foursquare id

Parameters:

value - value of "foursquare id" parameter.

Returns:

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

deletePlace

public PhotosEditQuery deletePlace(java.lang.Boolean value)

Set delete place

Parameters:

value - value of "delete place" parameter.

Returns:

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

getThis

protected PhotosEditQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<PhotosEditQuery,OkResponse>

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<PhotosEditQuery,OkResponse>

Returns:

list of names