Package com.vk.api.sdk.queries.users

Class UsersGetSubscriptionsQueryWithExtended

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<UsersGetSubscriptionsQueryWithExtended,GetSubscriptionsExtendedResponse>

com.vk.api.sdk.queries.users.UsersGetSubscriptionsQueryWithExtended

public class UsersGetSubscriptionsQueryWithExtended
extends AbstractQueryBuilder<UsersGetSubscriptionsQueryWithExtended,GetSubscriptionsExtendedResponse>

Query for Users.getSubscriptions method

Constructor Summary

Constructors

Constructor	Description
UsersGetSubscriptionsQueryWithExtended(VkApiClient client, ServiceActor actor)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
UsersGetSubscriptionsQueryWithExtended(VkApiClient client, UserActor actor)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Method Summary

Modifier and Type	Method	Description
UsersGetSubscriptionsQueryWithExtended	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
protected UsersGetSubscriptionsQueryWithExtended	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)
UsersGetSubscriptionsQueryWithExtended	fields(Fields... value)	fields Set fields
UsersGetSubscriptionsQueryWithExtended	fields(java.util.List<Fields> value)	Set fields
protected UsersGetSubscriptionsQueryWithExtended	getThis()	Get reference to this object
UsersGetSubscriptionsQueryWithExtended	offset(java.lang.Integer value)	Offset needed to return a specific subset of subscriptions.
UsersGetSubscriptionsQueryWithExtended	userId(java.lang.Integer value)	User ID.

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UsersGetSubscriptionsQueryWithExtended

public UsersGetSubscriptionsQueryWithExtended(VkApiClient client,
                                              UserActor actor)

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

Parameters:

client - VK API client

actor - actor with access token

UsersGetSubscriptionsQueryWithExtended

public UsersGetSubscriptionsQueryWithExtended(VkApiClient client,
                                              ServiceActor actor)

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

Parameters:

client - VK API client

actor - actor with access token

Method Detail

userId

public UsersGetSubscriptionsQueryWithExtended userId(java.lang.Integer value)

User ID.

Parameters:

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

Returns:

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

extended

protected UsersGetSubscriptionsQueryWithExtended 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 UsersGetSubscriptionsQueryWithExtended 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 UsersGetSubscriptionsQueryWithExtended 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 UsersGetSubscriptionsQueryWithExtended 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 UsersGetSubscriptionsQueryWithExtended 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 UsersGetSubscriptionsQueryWithExtended getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<UsersGetSubscriptionsQueryWithExtended,GetSubscriptionsExtendedResponse>

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<UsersGetSubscriptionsQueryWithExtended,GetSubscriptionsExtendedResponse>

Returns:

list of names