com.vk.api.sdk.queries.photos

Class PhotosSearchQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<PhotosSearchQuery,SearchResponse>

com.vk.api.sdk.queries.photos.PhotosSearchQuery

public class PhotosSearchQuery
extends AbstractQueryBuilder<PhotosSearchQuery,SearchResponse>

Query for Photos.search method

Constructor Summary

Constructors

Constructor and Description
PhotosSearchQuery(VkApiClient client, ServiceActor actor) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
PhotosSearchQuery(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
PhotosSearchQuery	count(java.lang.Integer value) Number of photos to return.
PhotosSearchQuery	endTime(java.lang.Integer value) Set end time
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected PhotosSearchQuery	getThis() Get reference to this object
PhotosSearchQuery	lat(java.lang.Number value) Geographical latitude, in degrees (from '-90' to '90').
PhotosSearchQuery	lng(java.lang.Number value) Geographical longitude, in degrees (from '-180' to '180').
PhotosSearchQuery	offset(java.lang.Integer value) Offset needed to return a specific subset of photos.
PhotosSearchQuery	q(java.lang.String value) Search query string.
PhotosSearchQuery	radius(java.lang.Integer value) Radius of search in meters (works very approximately).
PhotosSearchQuery	sort(java.lang.Integer value) Sort order:
PhotosSearchQuery	startTime(java.lang.Integer value) Set start time

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

PhotosSearchQuery

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

PhotosSearchQuery

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

q

public PhotosSearchQuery q(java.lang.String value)

Search query string.

Parameters:

value - value of "q" parameter.

Returns:

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

lat

public PhotosSearchQuery lat(java.lang.Number value)

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

Parameters:

value - value of "lat" parameter.

Returns:

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

lng

public PhotosSearchQuery lng(java.lang.Number value)

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

Parameters:

value - value of "long" parameter.

Returns:

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

startTime

public PhotosSearchQuery startTime(java.lang.Integer value)

Set start time

Parameters:

value - value of "start time" parameter. Minimum is 0.

Returns:

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

endTime

public PhotosSearchQuery endTime(java.lang.Integer value)

Set end time

Parameters:

value - value of "end time" parameter. Minimum is 0.

Returns:

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

sort

public PhotosSearchQuery sort(java.lang.Integer value)

Sort order:

Parameters:

value - value of "sort" parameter. Minimum is 0.

Returns:

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

offset

public PhotosSearchQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of photos.

Parameters:

value - value of "offset" parameter. Minimum is 0.

Returns:

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

count

public PhotosSearchQuery count(java.lang.Integer value)

Number of photos to return.

Parameters:

value - value of "count" parameter. Maximum is 1000. Minimum is 0. By default 100.

Returns:

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

radius

public PhotosSearchQuery radius(java.lang.Integer value)

Radius of search in meters (works very approximately). Available values: '10', '100', '800', '6000', '50000'.

Parameters:

value - value of "radius" parameter. Minimum is 0. By default 5000.

Returns:

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

getThis

protected PhotosSearchQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<PhotosSearchQuery,SearchResponse>

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<PhotosSearchQuery,SearchResponse>

Returns:

list of names