Package com.vk.api.sdk.queries.database

Class DatabaseGetCitiesQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<DatabaseGetCitiesQuery,GetCitiesResponse>

com.vk.api.sdk.queries.database.DatabaseGetCitiesQuery

public class DatabaseGetCitiesQuery
extends AbstractQueryBuilder<DatabaseGetCitiesQuery,GetCitiesResponse>

Query for Database.getCities method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DatabaseGetCitiesQuery	count(java.lang.Integer value)	Number of cities to return.
protected DatabaseGetCitiesQuery	countryId(int value)	Country ID.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected DatabaseGetCitiesQuery	getThis()	Get reference to this object
DatabaseGetCitiesQuery	needAll(java.lang.Boolean value)	'1' — to return all cities in the country, '0' — to return major cities in the country (default),
DatabaseGetCitiesQuery	offset(java.lang.Integer value)	Offset needed to return a specific subset of cities.
DatabaseGetCitiesQuery	q(java.lang.String value)	Search query.
DatabaseGetCitiesQuery	regionId(java.lang.Integer value)	Region 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

DatabaseGetCitiesQuery

public DatabaseGetCitiesQuery(VkApiClient client,
                              UserActor actor,
                              int countryId)

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

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

Method Detail

countryId

protected DatabaseGetCitiesQuery countryId(int value)

Country ID.

Parameters:

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

Returns:

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

regionId

public DatabaseGetCitiesQuery regionId(java.lang.Integer value)

Region ID.

Parameters:

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

Returns:

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

q

public DatabaseGetCitiesQuery 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.

needAll

public DatabaseGetCitiesQuery needAll(java.lang.Boolean value)

'1' — to return all cities in the country, '0' — to return major cities in the country (default),

Parameters:

value - value of "need all" parameter.

Returns:

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

offset

public DatabaseGetCitiesQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of cities.

Parameters:

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

Returns:

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

count

public DatabaseGetCitiesQuery count(java.lang.Integer value)

Number of cities 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 DatabaseGetCitiesQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<DatabaseGetCitiesQuery,GetCitiesResponse>

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<DatabaseGetCitiesQuery,GetCitiesResponse>

Returns:

list of names