Package 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 Description PhotosSearchQuery(VkApiClient client, ServiceActor actor)Creates a AbstractQueryBuilder instance that can be used to build api request with various parametersPhotosSearchQuery(VkApiClient client, UserActor actor)Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PhotosSearchQuerycount(java.lang.Integer value)Number of photos to return.PhotosSearchQueryendTime(java.lang.Integer value)Set end timeprotected java.util.List<java.lang.String>essentialKeys()Get list of required parameter namesprotected PhotosSearchQuerygetThis()Get reference to this objectPhotosSearchQuerylat(java.lang.Number value)Geographical latitude, in degrees (from '-90' to '90').PhotosSearchQuerylng(java.lang.Number value)Geographical longitude, in degrees (from '-180' to '180').PhotosSearchQueryoffset(java.lang.Integer value)Offset needed to return a specific subset of photos.PhotosSearchQueryq(java.lang.String value)Search query string.PhotosSearchQueryradius(java.lang.Integer value)Radius of search in meters (works very approximately).PhotosSearchQuerysort(java.lang.Integer value)Sort order:PhotosSearchQuerystartTime(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, lang, toString, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, version
-
Methods inherited from class com.vk.api.sdk.client.ApiRequest
execute, executeAsRaw, executeAsString, getClient, getGson, getHeaders, getResponseClass, getUrl, setHeaders
-
-
-
-
Constructor Detail
-
PhotosSearchQuery
public PhotosSearchQuery(VkApiClient client, UserActor actor)
Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters- Parameters:
client- VK API clientactor- actor with access token
-
PhotosSearchQuery
public PhotosSearchQuery(VkApiClient client, ServiceActor actor)
Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters- Parameters:
client- VK API clientactor- 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
getThis
protected PhotosSearchQuery getThis()
Description copied from class:AbstractQueryBuilderGet reference to this object- Specified by:
getThisin classAbstractQueryBuilder<PhotosSearchQuery,SearchResponse>- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
essentialKeys
protected java.util.List<java.lang.String> essentialKeys()
Description copied from class:AbstractQueryBuilderGet list of required parameter names- Specified by:
essentialKeysin classAbstractQueryBuilder<PhotosSearchQuery,SearchResponse>- Returns:
- list of names
-
-