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

Class DatabaseGetSchoolsQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<DatabaseGetSchoolsQuery,GetSchoolsResponse>

com.vk.api.sdk.queries.database.DatabaseGetSchoolsQuery

public class DatabaseGetSchoolsQuery
extends AbstractQueryBuilder<DatabaseGetSchoolsQuery,GetSchoolsResponse>

Query for Database.getSchools method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected DatabaseGetSchoolsQuery	cityId(int value)	City ID.
DatabaseGetSchoolsQuery	count(java.lang.Integer value)	Number of schools to return.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected DatabaseGetSchoolsQuery	getThis()	Get reference to this object
DatabaseGetSchoolsQuery	offset(java.lang.Integer value)	Offset needed to return a specific subset of schools.
DatabaseGetSchoolsQuery	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, 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

DatabaseGetSchoolsQuery

public DatabaseGetSchoolsQuery(VkApiClient client,
                               UserActor actor,
                               int cityId)

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

cityId - value of "city id" parameter. Minimum is 0.

DatabaseGetSchoolsQuery

public DatabaseGetSchoolsQuery(VkApiClient client,
                               ServiceActor actor,
                               int cityId)

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

cityId - value of "city id" parameter. Minimum is 0.

Method Detail

q

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

cityId

protected DatabaseGetSchoolsQuery cityId(int value)

City ID.

Parameters:

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

Returns:

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

offset

public DatabaseGetSchoolsQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of schools.

Parameters:

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

Returns:

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

count

public DatabaseGetSchoolsQuery count(java.lang.Integer value)

Number of schools to return.

Parameters:

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

Returns:

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

getThis

protected DatabaseGetSchoolsQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<DatabaseGetSchoolsQuery,GetSchoolsResponse>

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<DatabaseGetSchoolsQuery,GetSchoolsResponse>

Returns:

list of names