com.vk.api.sdk.queries.storage

Class StorageGetKeysQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<StorageGetKeysQuery,java.util.List<java.lang.String>>

com.vk.api.sdk.queries.storage.StorageGetKeysQuery

public class StorageGetKeysQuery
extends AbstractQueryBuilder<StorageGetKeysQuery,java.util.List<java.lang.String>>

Query for Storage.getKeys method

Constructor Summary

Constructors

Constructor and Description
StorageGetKeysQuery(VkApiClient client, GroupActor actor) Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
StorageGetKeysQuery(VkApiClient client, ServiceActor actor) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
StorageGetKeysQuery(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
StorageGetKeysQuery	count(java.lang.Integer value) Amount of variable names the info needs to be collected from.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected StorageGetKeysQuery	getThis() Get reference to this object
StorageGetKeysQuery	offset(java.lang.Integer value) Set offset
StorageGetKeysQuery	userId(java.lang.Long value) User id, whose variables names are returned if they were requested with a server method.

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

StorageGetKeysQuery

public StorageGetKeysQuery(VkApiClient client,
                           GroupActor actor)

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

Parameters:

client - VK API client

actor - actor with access token

StorageGetKeysQuery

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

StorageGetKeysQuery

public StorageGetKeysQuery(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 StorageGetKeysQuery userId(java.lang.Long value)

User id, whose variables names are returned if they were requested with a server method.

Parameters:

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

Returns:

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

offset

public StorageGetKeysQuery offset(java.lang.Integer value)

Set offset

Parameters:

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

Returns:

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

count

public StorageGetKeysQuery count(java.lang.Integer value)

Amount of variable names the info needs to be collected from.

Parameters:

value - value of "count" parameter. Maximum is 1000. Minimum is 0. By default 100.

Returns:

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

getThis

protected StorageGetKeysQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<StorageGetKeysQuery,java.util.List<java.lang.String>>

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<StorageGetKeysQuery,java.util.List<java.lang.String>>

Returns:

list of names