Package com.vk.api.sdk.queries.photos
Class PhotosGetQuery
- java.lang.Object
-
- com.vk.api.sdk.client.ApiRequest<R>
-
- com.vk.api.sdk.client.AbstractQueryBuilder<PhotosGetQuery,GetResponse>
-
- com.vk.api.sdk.queries.photos.PhotosGetQuery
-
public class PhotosGetQuery extends AbstractQueryBuilder<PhotosGetQuery,GetResponse>
Query for Photos.get method
-
-
Constructor Summary
Constructors Constructor Description PhotosGetQuery(VkApiClient client, ServiceActor actor)Creates a AbstractQueryBuilder instance that can be used to build api request with various parametersPhotosGetQuery(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 PhotosGetQueryalbumId(java.lang.String value)Photo album ID.PhotosGetQuerycount(java.lang.Integer value)Set countprotected java.util.List<java.lang.String>essentialKeys()Get list of required parameter namesPhotosGetQueryextended(java.lang.Boolean value)'1' — to return additional 'likes', 'comments', and 'tags' fields, '0' — (default)PhotosGetQueryfeed(java.lang.Integer value)Unixtime, that can be obtained with [vk.com/dev/newsfeed.get|newsfeed.get] method in date field to get all photos uploaded by the user on a specific day, or photos the user has been tagged on.PhotosGetQueryfeedType(java.lang.String value)Type of feed obtained in 'feed' field of the method.protected PhotosGetQuerygetThis()Get reference to this objectPhotosGetQueryoffset(java.lang.Integer value)Set offsetPhotosGetQueryownerId(java.lang.Integer value)ID of the user or community that owns the photos.PhotosGetQueryphotoIds(java.lang.String... value)photo_ids Photo IDs.PhotosGetQueryphotoIds(java.util.List<java.lang.String> value)Photo IDs.PhotosGetQueryphotoSizes(java.lang.Boolean value)'1' — to return photo sizes in a [vk.com/dev/photo_sizes|special format]PhotosGetQueryrev(java.lang.Boolean value)Sort order: '1' — reverse chronological, '0' — chronological-
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
-
PhotosGetQuery
public PhotosGetQuery(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
-
PhotosGetQuery
public PhotosGetQuery(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
-
ownerId
public PhotosGetQuery ownerId(java.lang.Integer value)
ID of the user or community that owns the photos. Use a negative value to designate a community ID.- Parameters:
value- value of "owner id" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
albumId
public PhotosGetQuery albumId(java.lang.String value)
Photo album ID. To return information about photos from service albums, use the following string values: 'profile, wall, saved'.- Parameters:
value- value of "album id" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
rev
public PhotosGetQuery rev(java.lang.Boolean value)
Sort order: '1' — reverse chronological, '0' — chronological- Parameters:
value- value of "rev" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
extended
public PhotosGetQuery extended(java.lang.Boolean value)
'1' — to return additional 'likes', 'comments', and 'tags' fields, '0' — (default)- Parameters:
value- value of "extended" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
feedType
public PhotosGetQuery feedType(java.lang.String value)
Type of feed obtained in 'feed' field of the method.- Parameters:
value- value of "feed type" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
feed
public PhotosGetQuery feed(java.lang.Integer value)
Unixtime, that can be obtained with [vk.com/dev/newsfeed.get|newsfeed.get] method in date field to get all photos uploaded by the user on a specific day, or photos the user has been tagged on. Also, 'uid' parameter of the user the event happened with shall be specified.- Parameters:
value- value of "feed" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
photoSizes
public PhotosGetQuery photoSizes(java.lang.Boolean value)
'1' — to return photo sizes in a [vk.com/dev/photo_sizes|special format]- Parameters:
value- value of "photo sizes" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
offset
public PhotosGetQuery offset(java.lang.Integer value)
Set offset- Parameters:
value- value of "offset" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
count
public PhotosGetQuery count(java.lang.Integer value)
Set count- Parameters:
value- value of "count" parameter. Maximum is 1000. Minimum is 0. By default 50.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
photoIds
public PhotosGetQuery photoIds(java.lang.String... value)
photo_ids Photo IDs.- Parameters:
value- value of "photo ids" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
photoIds
public PhotosGetQuery photoIds(java.util.List<java.lang.String> value)
Photo IDs.- Parameters:
value- value of "photo ids" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
getThis
protected PhotosGetQuery getThis()
Description copied from class:AbstractQueryBuilderGet reference to this object- Specified by:
getThisin classAbstractQueryBuilder<PhotosGetQuery,GetResponse>- 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<PhotosGetQuery,GetResponse>- Returns:
- list of names
-
-