com.vk.api.sdk.queries.video

Class VideoSearchQueryWithExtended

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<VideoSearchQueryWithExtended,SearchExtendedResponse>

com.vk.api.sdk.queries.video.VideoSearchQueryWithExtended

public class VideoSearchQueryWithExtended
extends AbstractQueryBuilder<VideoSearchQueryWithExtended,SearchExtendedResponse>

Query for Video.search method

Constructor Summary

Constructors

Constructor and Description
VideoSearchQueryWithExtended(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
VideoSearchQueryWithExtended	adult(java.lang.Boolean value) '1' - to disable the Safe Search filter, '0' - to enable the Safe Search filter
VideoSearchQueryWithExtended	count(java.lang.Integer value) Number of videos to return.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected VideoSearchQueryWithExtended	extended(java.lang.Boolean value) Set extended
VideoSearchQueryWithExtended	fields(java.util.List<java.lang.String> value) Set fields
VideoSearchQueryWithExtended	fields(java.lang.String... value) fields Set fields
VideoSearchQueryWithExtended	filters(java.util.List<java.lang.String> value) Filters to apply: 'youtube' - return YouTube videos only, 'vimeo' - return Vimeo videos only, 'short' - return short videos only, 'long' - return long videos only
VideoSearchQueryWithExtended	filters(java.lang.String... value) filters Filters to apply: 'youtube' - return YouTube videos only, 'vimeo' - return Vimeo videos only, 'short' - return short videos only, 'long' - return long videos only
protected VideoSearchQueryWithExtended	getThis() Get reference to this object
VideoSearchQueryWithExtended	hd(java.lang.Integer value) If not null, only searches for high-definition videos.
VideoSearchQueryWithExtended	live(java.lang.Boolean value) Set live
VideoSearchQueryWithExtended	longer(java.lang.Integer value) Set longer
VideoSearchQueryWithExtended	offset(java.lang.Integer value) Offset needed to return a specific subset of videos.
VideoSearchQueryWithExtended	ownerId(java.lang.Long value) Set owner id
VideoSearchQueryWithExtended	q(java.lang.String value) Search query string (e.g., 'The Beatles').
VideoSearchQueryWithExtended	searchOwn(java.lang.Boolean value) Set search own
VideoSearchQueryWithExtended	shorter(java.lang.Integer value) Set shorter
VideoSearchQueryWithExtended	sort(SearchSort value) Sort order: '1' - by duration, '2' - by relevance, '0' - by date added

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

VideoSearchQueryWithExtended

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

q

public VideoSearchQueryWithExtended q(java.lang.String value)

Search query string (e.g., 'The Beatles').

Parameters:

value - value of "q" parameter.

Returns:

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

sort

public VideoSearchQueryWithExtended sort(SearchSort value)

Sort order: '1' - by duration, '2' - by relevance, '0' - by date added

Parameters:

value - value of "sort" parameter.

Returns:

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

hd

public VideoSearchQueryWithExtended hd(java.lang.Integer value)

If not null, only searches for high-definition videos.

Parameters:

value - value of "hd" parameter.

Returns:

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

adult

public VideoSearchQueryWithExtended adult(java.lang.Boolean value)

'1' - to disable the Safe Search filter, '0' - to enable the Safe Search filter

Parameters:

value - value of "adult" parameter.

Returns:

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

live

public VideoSearchQueryWithExtended live(java.lang.Boolean value)

Set live

Parameters:

value - value of "live" parameter.

Returns:

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

searchOwn

public VideoSearchQueryWithExtended searchOwn(java.lang.Boolean value)

Set search own

Parameters:

value - value of "search own" parameter.

Returns:

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

offset

public VideoSearchQueryWithExtended 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.

longer

public VideoSearchQueryWithExtended longer(java.lang.Integer value)

Set longer

Parameters:

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

Returns:

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

shorter

public VideoSearchQueryWithExtended shorter(java.lang.Integer value)

Set shorter

Parameters:

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

Returns:

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

count

public VideoSearchQueryWithExtended count(java.lang.Integer value)

Number of videos to return.

Parameters:

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

Returns:

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

extended

protected VideoSearchQueryWithExtended extended(java.lang.Boolean value)

Set extended

Parameters:

value - value of "extended" parameter. By default 0.

Returns:

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

ownerId

public VideoSearchQueryWithExtended ownerId(java.lang.Long value)

Set owner id

Parameters:

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

Returns:

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

filters

public VideoSearchQueryWithExtended filters(java.lang.String... value)

filters Filters to apply: 'youtube' - return YouTube videos only, 'vimeo' - return Vimeo videos only, 'short' - return short videos only, 'long' - return long videos only

Parameters:

value - value of "filters" parameter.

Returns:

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

filters

public VideoSearchQueryWithExtended filters(java.util.List<java.lang.String> value)

Filters to apply: 'youtube' - return YouTube videos only, 'vimeo' - return Vimeo videos only, 'short' - return short videos only, 'long' - return long videos only

Parameters:

value - value of "filters" parameter.

Returns:

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

fields

public VideoSearchQueryWithExtended 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 VideoSearchQueryWithExtended 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 VideoSearchQueryWithExtended getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<VideoSearchQueryWithExtended,SearchExtendedResponse>

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<VideoSearchQueryWithExtended,SearchExtendedResponse>

Returns:

list of names