Package 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 Description VideoSaveQuery(VkApiClient client, UserActor actor)Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description VideoSaveQueryalbumId(java.lang.Integer value)ID of the album to which the saved video will be added.VideoSaveQuerycompression(java.lang.Boolean value)Set compressionVideoSaveQuerydescription(java.lang.String value)Description of the video.protected java.util.List<java.lang.String>essentialKeys()Get list of required parameter namesprotected VideoSaveQuerygetThis()Get reference to this objectVideoSaveQuerygroupId(java.lang.Integer value)ID of the community in which the video will be saved.VideoSaveQueryisPrivate(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 privateVideoSaveQuerylink(java.lang.String value)URL for embedding the video from an external website.VideoSaveQueryname(java.lang.String value)Name of the video.VideoSaveQuerynoComments(java.lang.Boolean value)Set no commentsVideoSaveQueryprivacyComment(java.lang.String... value)privacy_comment Set privacy commentVideoSaveQueryprivacyComment(java.util.List<java.lang.String> value)Set privacy commentVideoSaveQueryprivacyView(java.lang.String... value)privacy_view Set privacy viewVideoSaveQueryprivacyView(java.util.List<java.lang.String> value)Set privacy viewVideoSaveQueryrepeat(java.lang.Boolean value)'1' — to repeat the playback of the video, '0' — to play the video once,VideoSaveQuerywallpost(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, lang, toString, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, version
-
Methods inherited from class com.vk.api.sdk.client.ApiRequest
execute, executeAsRaw, executeAsString, getClient, getGson, getHeaders, getResponseClass, getUrl, setHeaders
-
-
-
-
Constructor Detail
-
VideoSaveQuery
public VideoSaveQuery(VkApiClient client, UserActor actor)
Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters- Parameters:
client- VK API clientactor- 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
groupId
public VideoSaveQuery groupId(java.lang.Integer 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 0.- Returns:
- a reference to this
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
privacyView
public VideoSaveQuery privacyView(java.lang.String... value)
privacy_view Set privacy view- Parameters:
value- value of "privacy view" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
privacyComment
public VideoSaveQuery privacyComment(java.lang.String... value)
privacy_comment Set privacy comment- Parameters:
value- value of "privacy comment" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
getThis
protected VideoSaveQuery getThis()
Description copied from class:AbstractQueryBuilderGet reference to this object- Specified by:
getThisin classAbstractQueryBuilder<VideoSaveQuery,SaveResponse>- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
essentialKeys
protected java.util.List<java.lang.String> essentialKeys()
Description copied from class:AbstractQueryBuilderGet list of required parameter names- Specified by:
essentialKeysin classAbstractQueryBuilder<VideoSaveQuery,SaveResponse>- Returns:
- list of names
-
-