com.vk.api.sdk.queries.video

Class VideoGetQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<VideoGetQuery,GetResponse>

com.vk.api.sdk.queries.video.VideoGetQuery

public class VideoGetQuery
extends AbstractQueryBuilder<VideoGetQuery,GetResponse>

Query for Video.get method

Constructor Summary

Constructors

Constructor and Description
VideoGetQuery(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
VideoGetQuery	albumId(java.lang.Integer value) ID of the album containing the video(s).
VideoGetQuery	count(java.lang.Integer value) Number of videos to return.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
VideoGetQuery	extended(java.lang.Boolean value) '1' - to return an extended response with additional fields
VideoGetQuery	fields(java.util.List<java.lang.String> value) Set fields
VideoGetQuery	fields(java.lang.String... value) fields Set fields
protected VideoGetQuery	getThis() Get reference to this object
VideoGetQuery	offset(java.lang.Integer value) Offset needed to return a specific subset of videos.
VideoGetQuery	ownerId(java.lang.Long value) ID of the user or community that owns the video(s).
VideoGetQuery	sortAlbum(GetSortAlbum value) Sort order: '0' - newest video first, '1' - oldest video first
VideoGetQuery	videos(java.util.List<java.lang.String> value) Video IDs, in the following format: "_,_", Use a negative value to designate a community ID.
VideoGetQuery	videos(java.lang.String... value) videos Video IDs, in the following format: "_,_", Use a negative value to designate a community ID.

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

VideoGetQuery

public VideoGetQuery(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 VideoGetQuery ownerId(java.lang.Long value)

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

Parameters:

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

Returns:

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

albumId

public VideoGetQuery albumId(java.lang.Integer value)

ID of the album containing the video(s).

Parameters:

value - value of "album id" parameter.

Returns:

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

count

public VideoGetQuery count(java.lang.Integer value)

Number of videos to return.

Parameters:

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

Returns:

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

offset

public VideoGetQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of videos.

Parameters:

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

Returns:

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

extended

public VideoGetQuery extended(java.lang.Boolean value)

'1' - to return an extended response with additional fields

Parameters:

value - value of "extended" parameter.

Returns:

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

sortAlbum

public VideoGetQuery sortAlbum(GetSortAlbum value)

Sort order: '0' - newest video first, '1' - oldest video first

Parameters:

value - value of "sort album" parameter. By default 0.

Returns:

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

videos

public VideoGetQuery videos(java.lang.String... value)

videos Video IDs, in the following format: "_,_", Use a negative value to designate a community ID. Example: "-4363_136089719,13245770_137352259"

Parameters:

value - value of "videos" parameter.

Returns:

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

videos

public VideoGetQuery videos(java.util.List<java.lang.String> value)

Video IDs, in the following format: "_,_", Use a negative value to designate a community ID. Example: "-4363_136089719,13245770_137352259"

Parameters:

value - value of "videos" parameter.

Returns:

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

fields

public VideoGetQuery fields(java.lang.String... value)

fields Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

public VideoGetQuery fields(java.util.List<java.lang.String> value)

Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected VideoGetQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<VideoGetQuery,GetResponse>

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<VideoGetQuery,GetResponse>

Returns:

list of names