com.vk.api.sdk.queries.video

Class VideoSaveQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<VideoSaveQuery,SaveResponse>

com.vk.api.sdk.queries.video.VideoSaveQuery

public class VideoSaveQuery
extends AbstractQueryBuilder<VideoSaveQuery,SaveResponse>

Query for Video.save method

Constructor Summary

Constructors

Constructor and Description
VideoSaveQuery(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
VideoSaveQuery	albumId(java.lang.Integer value) ID of the album to which the saved video will be added.
VideoSaveQuery	compression(java.lang.Boolean value) Set compression
VideoSaveQuery	description(java.lang.String value) Description of the video.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected VideoSaveQuery	getThis() Get reference to this object
VideoSaveQuery	groupId(java.lang.Long value) ID of the community in which the video will be saved.
VideoSaveQuery	isPrivate(java.lang.Boolean value) '1' - to designate the video as private (send it via a private message), the video will not appear on the user's video list and will not be available by ID for other users, '0' - not to designate the video as private
VideoSaveQuery	link(java.lang.String value) URL for embedding the video from an external website.
VideoSaveQuery	name(java.lang.String value) Name of the video.
VideoSaveQuery	noComments(java.lang.Boolean value) Set no comments
VideoSaveQuery	ordInfo(java.lang.String value) Set ord info
VideoSaveQuery	privacyComment(java.util.List<java.lang.String> value) Set privacy comment
VideoSaveQuery	privacyComment(java.lang.String... value) privacyComment Set privacy comment
VideoSaveQuery	privacyView(java.util.List<java.lang.String> value) Set privacy view
VideoSaveQuery	privacyView(java.lang.String... value) privacyView Set privacy view
VideoSaveQuery	repeat(java.lang.Boolean value) '1' - to repeat the playback of the video, '0' - to play the video once,
VideoSaveQuery	wallpost(java.lang.Boolean value) '1' - to post the saved video on a user's wall, '0' - not to post the saved video on a user's wall

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

VideoSaveQuery

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

name

public VideoSaveQuery name(java.lang.String value)

Name of the video.

Parameters:

value - value of "name" parameter.

Returns:

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

description

public VideoSaveQuery description(java.lang.String value)

Description of the video.

Parameters:

value - value of "description" parameter.

Returns:

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

isPrivate

public VideoSaveQuery isPrivate(java.lang.Boolean value)

'1' - to designate the video as private (send it via a private message), the video will not appear on the user's video list and will not be available by ID for other users, '0' - not to designate the video as private

Parameters:

value - value of "is private" parameter.

Returns:

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

wallpost

public VideoSaveQuery wallpost(java.lang.Boolean value)

'1' - to post the saved video on a user's wall, '0' - not to post the saved video on a user's wall

Parameters:

value - value of "wallpost" parameter.

Returns:

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

link

public VideoSaveQuery link(java.lang.String value)

URL for embedding the video from an external website.

Parameters:

value - value of "link" parameter.

Returns:

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

groupId

public VideoSaveQuery groupId(java.lang.Long value)

ID of the community in which the video will be saved. By default, the current user's page.

Parameters:

value - value of "group id" parameter. Minimum is 1. Entity - owner

Returns:

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

albumId

public VideoSaveQuery albumId(java.lang.Integer value)

ID of the album to which the saved video will be added.

Parameters:

value - value of "album id" parameter. Minimum is 0.

Returns:

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

noComments

public VideoSaveQuery noComments(java.lang.Boolean value)

Set no comments

Parameters:

value - value of "no comments" parameter.

Returns:

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

repeat

public VideoSaveQuery repeat(java.lang.Boolean value)

'1' - to repeat the playback of the video, '0' - to play the video once,

Parameters:

value - value of "repeat" parameter.

Returns:

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

compression

public VideoSaveQuery compression(java.lang.Boolean value)

Set compression

Parameters:

value - value of "compression" parameter.

Returns:

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

ordInfo

public VideoSaveQuery ordInfo(java.lang.String value)

Set ord info

Parameters:

value - value of "ord info" parameter.

Returns:

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

privacyView

public VideoSaveQuery privacyView(java.lang.String... value)

privacyView Set privacy view

Parameters:

value - value of "privacy view" parameter.

Returns:

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

privacyView

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

Set privacy view

Parameters:

value - value of "privacy view" parameter.

Returns:

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

privacyComment

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

privacyComment Set privacy comment

Parameters:

value - value of "privacy comment" parameter.

Returns:

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

privacyComment

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

Set privacy comment

Parameters:

value - value of "privacy comment" parameter.

Returns:

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

getThis

protected VideoSaveQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<VideoSaveQuery,SaveResponse>

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<VideoSaveQuery,SaveResponse>

Returns:

list of names