com.vk.api.sdk.queries.database

Class DatabaseGetRegionsQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<DatabaseGetRegionsQuery,GetRegionsResponse>

com.vk.api.sdk.queries.database.DatabaseGetRegionsQuery

public class DatabaseGetRegionsQuery
extends AbstractQueryBuilder<DatabaseGetRegionsQuery,GetRegionsResponse>

Query for Database.getRegions method

Constructor Summary

Constructors

Constructor and Description
DatabaseGetRegionsQuery(VkApiClient client, ServiceActor actor) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
DatabaseGetRegionsQuery(VkApiClient client, ServiceActor actor, java.lang.Integer countryId) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
DatabaseGetRegionsQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
DatabaseGetRegionsQuery(VkApiClient client, UserActor actor, java.lang.Integer countryId) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
DatabaseGetRegionsQuery	count(java.lang.Integer value) Number of regions to return.
DatabaseGetRegionsQuery	countryId(java.lang.Integer value) Country ID, received in [vk.com/dev/database.getCountries|database.getCountries] method.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected DatabaseGetRegionsQuery	getThis() Get reference to this object
DatabaseGetRegionsQuery	offset(java.lang.Integer value) Offset needed to return specific subset of regions.
DatabaseGetRegionsQuery	q(java.lang.String value) Search query.

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

DatabaseGetRegionsQuery

public DatabaseGetRegionsQuery(VkApiClient client,
                               UserActor actor,
                               java.lang.Integer countryId)

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

countryId - value of "country id" parameter. Minimum is 0.

DatabaseGetRegionsQuery

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

DatabaseGetRegionsQuery

public DatabaseGetRegionsQuery(VkApiClient client,
                               ServiceActor actor,
                               java.lang.Integer countryId)

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

countryId - value of "country id" parameter. Minimum is 0.

DatabaseGetRegionsQuery

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

countryId

public DatabaseGetRegionsQuery countryId(java.lang.Integer value)

Country ID, received in [vk.com/dev/database.getCountries|database.getCountries] method.

Parameters:

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

Returns:

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

q

public DatabaseGetRegionsQuery q(java.lang.String value)

Search query.

Parameters:

value - value of "q" parameter.

Returns:

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

offset

public DatabaseGetRegionsQuery offset(java.lang.Integer value)

Offset needed to return specific subset of regions.

Parameters:

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

Returns:

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

count

public DatabaseGetRegionsQuery count(java.lang.Integer value)

Number of regions to return.

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 DatabaseGetRegionsQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<DatabaseGetRegionsQuery,GetRegionsResponse>

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<DatabaseGetRegionsQuery,GetRegionsResponse>

Returns:

list of names