com.vk.api.sdk.queries.video

Class VideoGetAlbumsQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<VideoGetAlbumsQuery,GetAlbumsResponse>

com.vk.api.sdk.queries.video.VideoGetAlbumsQuery

public class VideoGetAlbumsQuery
extends AbstractQueryBuilder<VideoGetAlbumsQuery,GetAlbumsResponse>

Query for Video.getAlbums method

Constructor Summary

Constructors

Constructor and Description
VideoGetAlbumsQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
VideoGetAlbumsQuery	count(java.lang.Integer value) Number of video albums to return.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
VideoGetAlbumsQuery	extended(java.lang.Boolean value) '1' - to return additional information about album privacy settings for the current user
protected VideoGetAlbumsQuery	getThis() Get reference to this object
VideoGetAlbumsQuery	needSystem(java.lang.Boolean value) Set need system
VideoGetAlbumsQuery	offset(java.lang.Integer value) Offset needed to return a specific subset of video albums.
VideoGetAlbumsQuery	ownerId(java.lang.Long value) ID of the user or community that owns the video album(s).

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

VideoGetAlbumsQuery

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

ownerId

public VideoGetAlbumsQuery ownerId(java.lang.Long value)

ID of the user or community that owns the video album(s).

Parameters:

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

Returns:

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

offset

public VideoGetAlbumsQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of video albums.

Parameters:

value - value of "offset" parameter. Minimum is 0.

Returns:

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

count

public VideoGetAlbumsQuery count(java.lang.Integer value)

Number of video albums to return.

Parameters:

value - value of "count" parameter. Maximum is 100. Minimum is 0. By default 50.

Returns:

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

extended

public VideoGetAlbumsQuery extended(java.lang.Boolean value)

'1' - to return additional information about album privacy settings for the current user

Parameters:

value - value of "extended" parameter.

Returns:

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

needSystem

public VideoGetAlbumsQuery needSystem(java.lang.Boolean value)

Set need system

Parameters:

value - value of "need system" parameter. By default 0.

Returns:

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

getThis

protected VideoGetAlbumsQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<VideoGetAlbumsQuery,GetAlbumsResponse>

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<VideoGetAlbumsQuery,GetAlbumsResponse>

Returns:

list of names