com.vk.api.sdk.queries.database

Class DatabaseGetCountriesQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<DatabaseGetCountriesQuery,GetCountriesResponse>

com.vk.api.sdk.queries.database.DatabaseGetCountriesQuery

public class DatabaseGetCountriesQuery
extends AbstractQueryBuilder<DatabaseGetCountriesQuery,GetCountriesResponse>

Query for Database.getCountries method

Constructor Summary

Constructors

Constructor and Description
DatabaseGetCountriesQuery(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
DatabaseGetCountriesQuery	code(java.lang.String value) Country codes in [vk.com/dev/country_codes|ISO 3166-1 alpha-2] standard.
DatabaseGetCountriesQuery	count(java.lang.Integer value) Number of countries to return.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected DatabaseGetCountriesQuery	getThis() Get reference to this object
DatabaseGetCountriesQuery	needAll(java.lang.Boolean value) '1' - to return a full list of all countries, '0' - to return a list of countries near the current user's country (default).
DatabaseGetCountriesQuery	offset(java.lang.Integer value) Offset needed to return a specific subset of countries.

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

DatabaseGetCountriesQuery

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

Method Detail

needAll

public DatabaseGetCountriesQuery needAll(java.lang.Boolean value)

'1' - to return a full list of all countries, '0' - to return a list of countries near the current user's country (default).

Parameters:

value - value of "need all" parameter.

Returns:

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

code

public DatabaseGetCountriesQuery code(java.lang.String value)

Country codes in [vk.com/dev/country_codes|ISO 3166-1 alpha-2] standard.

Parameters:

value - value of "code" parameter.

Returns:

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

offset

public DatabaseGetCountriesQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of countries.

Parameters:

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

Returns:

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

count

public DatabaseGetCountriesQuery count(java.lang.Integer value)

Number of countries 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 DatabaseGetCountriesQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<DatabaseGetCountriesQuery,GetCountriesResponse>

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<DatabaseGetCountriesQuery,GetCountriesResponse>

Returns:

list of names