Package com.vk.api.sdk.queries.photos
Class PhotosGetAllQueryWithExtended
- java.lang.Object
-
- com.vk.api.sdk.client.ApiRequest<R>
-
- com.vk.api.sdk.client.AbstractQueryBuilder<PhotosGetAllQueryWithExtended,GetAllExtendedResponse>
-
- com.vk.api.sdk.queries.photos.PhotosGetAllQueryWithExtended
-
public class PhotosGetAllQueryWithExtended extends AbstractQueryBuilder<PhotosGetAllQueryWithExtended,GetAllExtendedResponse>
Query for Photos.getAll method
-
-
Constructor Summary
Constructors Constructor Description PhotosGetAllQueryWithExtended(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 PhotosGetAllQueryWithExtendedcount(java.lang.Integer value)Number of photos to return.protected java.util.List<java.lang.String>essentialKeys()Get list of required parameter namesprotected PhotosGetAllQueryWithExtendedextended(java.lang.Boolean value)'1' — to return detailed information about photosprotected PhotosGetAllQueryWithExtendedgetThis()Get reference to this objectPhotosGetAllQueryWithExtendedneedHidden(java.lang.Boolean value)'1' - to show information about photos being hidden from the block above the wall.PhotosGetAllQueryWithExtendednoServiceAlbums(java.lang.Boolean value)'1' - to return photos only from standard albums, '0' - to return all photos including those in service albums, e.g., 'My wall photos' (default)PhotosGetAllQueryWithExtendedoffset(java.lang.Integer value)Offset needed to return a specific subset of photos.PhotosGetAllQueryWithExtendedownerId(java.lang.Integer value)ID of a user or community that owns the photos.PhotosGetAllQueryWithExtendedphotoSizes(java.lang.Boolean value)'1' - to return image sizes in [vk.com/dev/photo_sizes|special format].PhotosGetAllQueryWithExtendedskipHidden(java.lang.Boolean value)'1' - not to return photos being hidden from the block above the wall.-
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
-
PhotosGetAllQueryWithExtended
public PhotosGetAllQueryWithExtended(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
-
-
Method Detail
-
ownerId
public PhotosGetAllQueryWithExtended ownerId(java.lang.Integer value)
ID of a 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.
-
extended
protected PhotosGetAllQueryWithExtended extended(java.lang.Boolean value)
'1' — to return detailed information about photos- Parameters:
value- value of "extended" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
offset
public PhotosGetAllQueryWithExtended offset(java.lang.Integer value)
Offset needed to return a specific subset of photos. By default, '0'.- Parameters:
value- value of "offset" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
count
public PhotosGetAllQueryWithExtended count(java.lang.Integer value)
Number of photos to return.- Parameters:
value- value of "count" parameter. Maximum is 200. Minimum is 0. By default 20.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
photoSizes
public PhotosGetAllQueryWithExtended photoSizes(java.lang.Boolean value)
'1' - to return image sizes in [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.
-
noServiceAlbums
public PhotosGetAllQueryWithExtended noServiceAlbums(java.lang.Boolean value)
'1' - to return photos only from standard albums, '0' - to return all photos including those in service albums, e.g., 'My wall photos' (default)- Parameters:
value- value of "no service albums" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
needHidden
public PhotosGetAllQueryWithExtended needHidden(java.lang.Boolean value)
'1' - to show information about photos being hidden from the block above the wall.- Parameters:
value- value of "need hidden" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
skipHidden
public PhotosGetAllQueryWithExtended skipHidden(java.lang.Boolean value)
'1' - not to return photos being hidden from the block above the wall. Works only with owner_id>0, no_service_albums is ignored.- Parameters:
value- value of "skip hidden" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
getThis
protected PhotosGetAllQueryWithExtended getThis()
Description copied from class:AbstractQueryBuilderGet reference to this object- Specified by:
getThisin classAbstractQueryBuilder<PhotosGetAllQueryWithExtended,GetAllExtendedResponse>- 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<PhotosGetAllQueryWithExtended,GetAllExtendedResponse>- Returns:
- list of names
-
-