com.vk.api.sdk.queries.users.UsersGetSubscriptionsQueryWithExtended 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.users;
import com.vk.api.sdk.client.AbstractQueryBuilder;
import com.vk.api.sdk.client.VkApiClient;
import com.vk.api.sdk.client.actors.ServiceActor;
import com.vk.api.sdk.client.actors.UserActor;
import com.vk.api.sdk.objects.annotations.ApiParam;
import com.vk.api.sdk.objects.users.Fields;
import com.vk.api.sdk.objects.users.responses.GetSubscriptionsExtendedResponse;
import java.util.Arrays;
import java.util.List;
/**
* Query for Users.getSubscriptions method
*/
public class UsersGetSubscriptionsQueryWithExtended 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 UsersGetSubscriptionsQueryWithExtended(VkApiClient client, UserActor actor) {
super(client, "users.getSubscriptions", GetSubscriptionsExtendedResponse.class);
accessToken(actor.getAccessToken());
extended(true);
}
/**
* Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
*
* @param client VK API client
* @param actor actor with access token
*/
public UsersGetSubscriptionsQueryWithExtended(VkApiClient client, ServiceActor actor) {
super(client, "users.getSubscriptions", GetSubscriptionsExtendedResponse.class);
accessToken(actor.getAccessToken());
clientSecret(actor.getClientSecret());
extended(true);
}
/**
* User ID.
*
* @param value value of "user id" parameter. Minimum is 0. Entity - owner
*
* @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
*/
@ApiParam("user_id")
public UsersGetSubscriptionsQueryWithExtended userId(Long value) {
return unsafeParam("user_id", value);
}
/**
* '1' - to return a combined list of users and communities, '0' - to return separate lists of users and communities (default)
*
* @param value value of "extended" parameter.
* @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
*/
@ApiParam("extended")
protected UsersGetSubscriptionsQueryWithExtended extended(Boolean value) {
return unsafeParam("extended", value);
}
/**
* Offset needed to return a specific subset of subscriptions.
*
* @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 UsersGetSubscriptionsQueryWithExtended offset(Integer value) {
return unsafeParam("offset", value);
}
/**
* Number of users and communities to return.
*
* @param value value of "count" parameter. Maximum is 200. Minimum is 0. By default 20.
* @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
*/
@ApiParam("count")
public UsersGetSubscriptionsQueryWithExtended count(Integer value) {
return unsafeParam("count", value);
}
/**
* fields
* Set fields
*
* @param value value of "fields" parameter.
* @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
*/
@ApiParam("fields")
public UsersGetSubscriptionsQueryWithExtended fields(Fields... value) {
return unsafeParam("fields", value);
}
/**
* Set fields
*
* @param value value of "fields" parameter.
* @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
*/
@ApiParam("fields")
public UsersGetSubscriptionsQueryWithExtended fields(List value) {
return unsafeParam("fields", value);
}
@Override
protected UsersGetSubscriptionsQueryWithExtended getThis() {
return this;
}
@Override
protected List essentialKeys() {
return Arrays.asList("access_token");
}
}