com.vk.api.sdk.queries.photos

Class PhotosEditAlbumQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<PhotosEditAlbumQuery,OkResponse>

com.vk.api.sdk.queries.photos.PhotosEditAlbumQuery

public class PhotosEditAlbumQuery
extends AbstractQueryBuilder<PhotosEditAlbumQuery,OkResponse>

Query for Photos.editAlbum method

Constructor Summary

Constructors

Constructor and Description
PhotosEditAlbumQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
PhotosEditAlbumQuery(VkApiClient client, UserActor actor, java.lang.Integer albumId) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
PhotosEditAlbumQuery	albumId(java.lang.Integer value) ID of the photo album to be edited.
PhotosEditAlbumQuery	commentsDisabled(java.lang.Boolean value) Set comments disabled
PhotosEditAlbumQuery	description(java.lang.String value) New album description.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected PhotosEditAlbumQuery	getThis() Get reference to this object
PhotosEditAlbumQuery	ownerId(java.lang.Long value) ID of the user or community that owns the album.
PhotosEditAlbumQuery	privacyComment(java.util.List<java.lang.String> value) Set privacy comment
PhotosEditAlbumQuery	privacyComment(java.lang.String... value) privacyComment Set privacy comment
PhotosEditAlbumQuery	privacyView(java.util.List<java.lang.String> value) Set privacy view
PhotosEditAlbumQuery	privacyView(java.lang.String... value) privacyView Set privacy view
PhotosEditAlbumQuery	title(java.lang.String value) New album title.
PhotosEditAlbumQuery	uploadByAdminsOnly(java.lang.Boolean value) Set upload by admins only

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

PhotosEditAlbumQuery

public PhotosEditAlbumQuery(VkApiClient client,
                            UserActor actor,
                            java.lang.Integer albumId)

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

albumId - value of "album id" parameter. Minimum is 0.

PhotosEditAlbumQuery

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

Method Detail

albumId

public PhotosEditAlbumQuery albumId(java.lang.Integer value)

ID of the photo album to be edited.

Parameters:

value - value of "album id" parameter. Minimum is 0.

Returns:

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

title

public PhotosEditAlbumQuery title(java.lang.String value)

New album title.

Parameters:

value - value of "title" parameter.

Returns:

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

description

public PhotosEditAlbumQuery description(java.lang.String value)

New album description.

Parameters:

value - value of "description" parameter.

Returns:

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

ownerId

public PhotosEditAlbumQuery ownerId(java.lang.Long value)

ID of the user or community that owns the album.

Parameters:

value - value of "owner id" parameter. Entity - owner

Returns:

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

uploadByAdminsOnly

public PhotosEditAlbumQuery uploadByAdminsOnly(java.lang.Boolean value)

Set upload by admins only

Parameters:

value - value of "upload by admins only" parameter.

Returns:

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

commentsDisabled

public PhotosEditAlbumQuery commentsDisabled(java.lang.Boolean value)

Set comments disabled

Parameters:

value - value of "comments disabled" parameter.

Returns:

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

privacyView

public PhotosEditAlbumQuery privacyView(java.lang.String... value)

privacyView Set privacy view

Parameters:

value - value of "privacy view" parameter.

Returns:

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

privacyView

public PhotosEditAlbumQuery privacyView(java.util.List<java.lang.String> value)

Set privacy view

Parameters:

value - value of "privacy view" parameter.

Returns:

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

privacyComment

public PhotosEditAlbumQuery privacyComment(java.lang.String... value)

privacyComment Set privacy comment

Parameters:

value - value of "privacy comment" parameter.

Returns:

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

privacyComment

public PhotosEditAlbumQuery privacyComment(java.util.List<java.lang.String> value)

Set privacy comment

Parameters:

value - value of "privacy comment" parameter.

Returns:

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

getThis

protected PhotosEditAlbumQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<PhotosEditAlbumQuery,OkResponse>

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<PhotosEditAlbumQuery,OkResponse>

Returns:

list of names