com.vk.api.sdk.queries.users

Class UsersGetSubscriptionsQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<UsersGetSubscriptionsQuery,GetSubscriptionsResponse>

com.vk.api.sdk.queries.users.UsersGetSubscriptionsQuery

public class UsersGetSubscriptionsQuery
extends AbstractQueryBuilder<UsersGetSubscriptionsQuery,GetSubscriptionsResponse>

Query for Users.getSubscriptions method

Constructor Summary

Constructors

Constructor and Description
UsersGetSubscriptionsQuery(VkApiClient client, ServiceActor actor) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
UsersGetSubscriptionsQuery(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
UsersGetSubscriptionsQuery	count(java.lang.Integer value) Number of users and communities to return.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
UsersGetSubscriptionsQuery	extended(java.lang.Boolean value) '1' - to return a combined list of users and communities, '0' - to return separate lists of users and communities (default)
UsersGetSubscriptionsQuery	fields(Fields... value) fields Set fields
UsersGetSubscriptionsQuery	fields(java.util.List<Fields> value) Set fields
protected UsersGetSubscriptionsQuery	getThis() Get reference to this object
UsersGetSubscriptionsQuery	offset(java.lang.Integer value) Offset needed to return a specific subset of subscriptions.
UsersGetSubscriptionsQuery	userId(java.lang.Long value) User ID.

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

UsersGetSubscriptionsQuery

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

UsersGetSubscriptionsQuery

public UsersGetSubscriptionsQuery(VkApiClient client,
                                  ServiceActor actor)

Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

Method Detail

userId

public UsersGetSubscriptionsQuery userId(java.lang.Long value)

User ID.

Parameters:

value - value of "user id" parameter. Minimum is 0. Entity - owner

Returns:

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

extended

public UsersGetSubscriptionsQuery extended(java.lang.Boolean value)

'1' - to return a combined list of users and communities, '0' - to return separate lists of users and communities (default)

Parameters:

value - value of "extended" parameter.

Returns:

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

offset

public UsersGetSubscriptionsQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of subscriptions.

Parameters:

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

Returns:

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

count

public UsersGetSubscriptionsQuery count(java.lang.Integer value)

Number of users and communities 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.

fields

public UsersGetSubscriptionsQuery fields(Fields... value)

fields Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

public UsersGetSubscriptionsQuery fields(java.util.List<Fields> value)

Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected UsersGetSubscriptionsQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<UsersGetSubscriptionsQuery,GetSubscriptionsResponse>

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<UsersGetSubscriptionsQuery,GetSubscriptionsResponse>

Returns:

list of names