com.vk.api.sdk.queries.photos

Class PhotosPutTagQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<PhotosPutTagQuery,java.lang.Integer>

com.vk.api.sdk.queries.photos.PhotosPutTagQuery

public class PhotosPutTagQuery
extends AbstractQueryBuilder<PhotosPutTagQuery,java.lang.Integer>

Query for Photos.putTag method

Constructor Summary

Constructors

Constructor and Description
PhotosPutTagQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
PhotosPutTagQuery(VkApiClient client, UserActor actor, java.lang.Integer photoId, java.lang.Long userId) 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
protected PhotosPutTagQuery	getThis() Get reference to this object
PhotosPutTagQuery	ownerId(java.lang.Long value) ID of the user or community that owns the photo.
PhotosPutTagQuery	photoId(java.lang.Integer value) Photo ID.
PhotosPutTagQuery	userId(java.lang.Long value) ID of the user to be tagged.
PhotosPutTagQuery	x(java.lang.Number value) Upper left-corner coordinate of the tagged area (as a percentage of the photo's width).
PhotosPutTagQuery	x2(java.lang.Number value) Lower right-corner coordinate of the tagged area (as a percentage of the photo's width).
PhotosPutTagQuery	y(java.lang.Number value) Upper left-corner coordinate of the tagged area (as a percentage of the photo's height).
PhotosPutTagQuery	y2(java.lang.Number value) Lower right-corner coordinate of the tagged area (as a percentage of the photo's height).

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

PhotosPutTagQuery

public PhotosPutTagQuery(VkApiClient client,
                         UserActor actor,
                         java.lang.Integer photoId,
                         java.lang.Long userId)

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.

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

PhotosPutTagQuery

public PhotosPutTagQuery(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 PhotosPutTagQuery 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 PhotosPutTagQuery 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.

userId

public PhotosPutTagQuery userId(java.lang.Long value)

ID of the user to be tagged.

Parameters:

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

Returns:

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

x

public PhotosPutTagQuery x(java.lang.Number value)

Upper left-corner coordinate of the tagged area (as a percentage of the photo's width).

Parameters:

value - value of "x" parameter.

Returns:

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

y

public PhotosPutTagQuery y(java.lang.Number value)

Upper left-corner coordinate of the tagged area (as a percentage of the photo's height).

Parameters:

value - value of "y" parameter.

Returns:

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

x2

public PhotosPutTagQuery x2(java.lang.Number value)

Lower right-corner coordinate of the tagged area (as a percentage of the photo's width).

Parameters:

value - value of "x2" parameter.

Returns:

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

y2

public PhotosPutTagQuery y2(java.lang.Number value)

Lower right-corner coordinate of the tagged area (as a percentage of the photo's height).

Parameters:

value - value of "y2" parameter.

Returns:

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

getThis

protected PhotosPutTagQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<PhotosPutTagQuery,java.lang.Integer>

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<PhotosPutTagQuery,java.lang.Integer>

Returns:

list of names