com.vk.api.sdk.queries.video.VideoGetAlbumsQueryWithExtended Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk Show documentation
Show all versions of sdk Show documentation
Java library for VK API interaction, includes OAuth 2.0 authorization and API methods.
The newest version!
// Autogenerated from vk-api-schema. Please don't edit it manually.
package com.vk.api.sdk.queries.video;
import com.vk.api.sdk.client.AbstractQueryBuilder;
import com.vk.api.sdk.client.VkApiClient;
import com.vk.api.sdk.client.actors.UserActor;
import com.vk.api.sdk.objects.annotations.ApiParam;
import com.vk.api.sdk.objects.video.responses.GetAlbumsExtendedResponse;
import java.util.Arrays;
import java.util.List;
/**
* Query for Video.getAlbums method
*/
public class VideoGetAlbumsQueryWithExtended extends AbstractQueryBuilder {
/**
* Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
*
* @param client VK API client
* @param actor actor with access token
*/
public VideoGetAlbumsQueryWithExtended(VkApiClient client, UserActor actor) {
super(client, "video.getAlbums", GetAlbumsExtendedResponse.class);
accessToken(actor.getAccessToken());
extended(true);
}
/**
* ID of the user or community that owns the video album(s).
*
* @param value value of "owner id" parameter. Entity - owner
*
* @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
*/
@ApiParam("owner_id")
public VideoGetAlbumsQueryWithExtended ownerId(Long value) {
return unsafeParam("owner_id", value);
}
/**
* Offset needed to return a specific subset of video albums.
*
* @param value value of "offset" parameter. Minimum is 0.
* @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
*/
@ApiParam("offset")
public VideoGetAlbumsQueryWithExtended offset(Integer value) {
return unsafeParam("offset", value);
}
/**
* Number of video albums to return.
*
* @param value value of "count" parameter. Maximum is 100. Minimum is 0. By default 50.
* @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
*/
@ApiParam("count")
public VideoGetAlbumsQueryWithExtended count(Integer value) {
return unsafeParam("count", value);
}
/**
* '1' - to return additional information about album privacy settings for the current user
*
* @param value value of "extended" parameter.
* @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
*/
@ApiParam("extended")
protected VideoGetAlbumsQueryWithExtended extended(Boolean value) {
return unsafeParam("extended", value);
}
/**
* Set need system
*
* @param value value of "need system" parameter. By default 0.
* @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
*/
@ApiParam("need_system")
public VideoGetAlbumsQueryWithExtended needSystem(Boolean value) {
return unsafeParam("need_system", value);
}
@Override
protected VideoGetAlbumsQueryWithExtended getThis() {
return this;
}
@Override
protected List essentialKeys() {
return Arrays.asList("access_token");
}
}