com.vk.api.sdk.queries.photos

Class PhotosCreateAlbumQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<PhotosCreateAlbumQuery,CreateAlbumResponse>

com.vk.api.sdk.queries.photos.PhotosCreateAlbumQuery

public class PhotosCreateAlbumQuery
extends AbstractQueryBuilder<PhotosCreateAlbumQuery,CreateAlbumResponse>

Query for Photos.createAlbum method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
PhotosCreateAlbumQuery	commentsDisabled(java.lang.Boolean value) Set comments disabled
PhotosCreateAlbumQuery	description(java.lang.String value) Album description.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected PhotosCreateAlbumQuery	getThis() Get reference to this object
PhotosCreateAlbumQuery	groupId(java.lang.Long value) ID of the community in which the album will be created.
PhotosCreateAlbumQuery	privacyComment(java.util.List<java.lang.String> value) Set privacy comment
PhotosCreateAlbumQuery	privacyComment(java.lang.String... value) privacyComment Set privacy comment
PhotosCreateAlbumQuery	privacyView(java.util.List<java.lang.String> value) Set privacy view
PhotosCreateAlbumQuery	privacyView(java.lang.String... value) privacyView Set privacy view
PhotosCreateAlbumQuery	title(java.lang.String value) Album title.
PhotosCreateAlbumQuery	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

PhotosCreateAlbumQuery

public PhotosCreateAlbumQuery(VkApiClient client,
                              UserActor actor,
                              java.lang.String title)

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

title - value of "title" parameter.

PhotosCreateAlbumQuery

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

title

public PhotosCreateAlbumQuery title(java.lang.String value)

Album title.

Parameters:

value - value of "title" parameter.

Returns:

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

groupId

public PhotosCreateAlbumQuery groupId(java.lang.Long value)

ID of the community in which the album will be created.

Parameters:

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

Returns:

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

description

public PhotosCreateAlbumQuery description(java.lang.String value)

Album description.

Parameters:

value - value of "description" parameter.

Returns:

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

uploadByAdminsOnly

public PhotosCreateAlbumQuery 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 PhotosCreateAlbumQuery 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 PhotosCreateAlbumQuery privacyView(java.lang.String... value)

privacyView Set privacy view

Parameters:

value - value of "privacy view" parameter. By default all.

Returns:

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

privacyView

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

Set privacy view

Parameters:

value - value of "privacy view" parameter. By default all.

Returns:

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

privacyComment

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

privacyComment Set privacy comment

Parameters:

value - value of "privacy comment" parameter. By default all.

Returns:

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

privacyComment

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

Set privacy comment

Parameters:

value - value of "privacy comment" parameter. By default all.

Returns:

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

getThis

protected PhotosCreateAlbumQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<PhotosCreateAlbumQuery,CreateAlbumResponse>

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<PhotosCreateAlbumQuery,CreateAlbumResponse>

Returns:

list of names