Package com.vk.api.sdk.queries.photos
Class PhotosGetQueryWithExtended
- java.lang.Object
-
- com.vk.api.sdk.client.ApiRequest<R>
-
- com.vk.api.sdk.client.AbstractQueryBuilder<PhotosGetQueryWithExtended,GetExtendedResponse>
-
- com.vk.api.sdk.queries.photos.PhotosGetQueryWithExtended
-
public class PhotosGetQueryWithExtended extends AbstractQueryBuilder<PhotosGetQueryWithExtended,GetExtendedResponse>
Query for Photos.get method
-
-
Constructor Summary
Constructors Constructor Description PhotosGetQueryWithExtended(VkApiClient client, ServiceActor actor)Creates a AbstractQueryBuilder instance that can be used to build api request with various parametersPhotosGetQueryWithExtended(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 PhotosGetQueryWithExtendedalbumId(java.lang.String value)Photo album ID.PhotosGetQueryWithExtendedcount(java.lang.Integer value)Set countprotected java.util.List<java.lang.String>essentialKeys()Get list of required parameter namesprotected PhotosGetQueryWithExtendedextended(java.lang.Boolean value)'1' — to return additional 'likes', 'comments', and 'tags' fields, '0' — (default)PhotosGetQueryWithExtendedfeed(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.PhotosGetQueryWithExtendedfeedType(java.lang.String value)Type of feed obtained in 'feed' field of the method.protected PhotosGetQueryWithExtendedgetThis()Get reference to this objectPhotosGetQueryWithExtendedoffset(java.lang.Integer value)Set offsetPhotosGetQueryWithExtendedownerId(java.lang.Integer value)ID of the user or community that owns the photos.PhotosGetQueryWithExtendedphotoIds(java.lang.String... value)photo_ids Photo IDs.PhotosGetQueryWithExtendedphotoIds(java.util.List<java.lang.String> value)Photo IDs.PhotosGetQueryWithExtendedphotoSizes(java.lang.Boolean value)'1' — to return photo sizes in a [vk.com/dev/photo_sizes|special format]PhotosGetQueryWithExtendedrev(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
-
PhotosGetQueryWithExtended
public PhotosGetQueryWithExtended(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
-
PhotosGetQueryWithExtended
public PhotosGetQueryWithExtended(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 PhotosGetQueryWithExtended 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 PhotosGetQueryWithExtended 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 PhotosGetQueryWithExtended 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
protected PhotosGetQueryWithExtended 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 PhotosGetQueryWithExtended 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 PhotosGetQueryWithExtended 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 PhotosGetQueryWithExtended 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 PhotosGetQueryWithExtended 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 PhotosGetQueryWithExtended 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 PhotosGetQueryWithExtended 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 PhotosGetQueryWithExtended 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 PhotosGetQueryWithExtended getThis()
Description copied from class:AbstractQueryBuilderGet reference to this object- Specified by:
getThisin classAbstractQueryBuilder<PhotosGetQueryWithExtended,GetExtendedResponse>- 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<PhotosGetQueryWithExtended,GetExtendedResponse>- Returns:
- list of names
-
-