com.vk.api.sdk.queries.video

Class VideoGetAlbumsQueryWithExtended

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<VideoGetAlbumsQueryWithExtended,GetAlbumsExtendedResponse>

com.vk.api.sdk.queries.video.VideoGetAlbumsQueryWithExtended

public class VideoGetAlbumsQueryWithExtended
extends AbstractQueryBuilder<VideoGetAlbumsQueryWithExtended,GetAlbumsExtendedResponse>

Query for Video.getAlbums method

Constructor Summary

Constructors

Constructor and Description
VideoGetAlbumsQueryWithExtended(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
VideoGetAlbumsQueryWithExtended	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
protected VideoGetAlbumsQueryWithExtended	extended(java.lang.Boolean value) '1' - to return additional information about album privacy settings for the current user
protected VideoGetAlbumsQueryWithExtended	getThis() Get reference to this object
VideoGetAlbumsQueryWithExtended	needSystem(java.lang.Boolean value) Set need system
VideoGetAlbumsQueryWithExtended	offset(java.lang.Integer value) Offset needed to return a specific subset of video albums.
VideoGetAlbumsQueryWithExtended	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

VideoGetAlbumsQueryWithExtended

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

protected VideoGetAlbumsQueryWithExtended 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 VideoGetAlbumsQueryWithExtended 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 VideoGetAlbumsQueryWithExtended getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<VideoGetAlbumsQueryWithExtended,GetAlbumsExtendedResponse>

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<VideoGetAlbumsQueryWithExtended,GetAlbumsExtendedResponse>

Returns:

list of names