Package com.vk.api.sdk.queries.groups

Class GroupsSearchQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<GroupsSearchQuery,SearchResponse>

com.vk.api.sdk.queries.groups.GroupsSearchQuery

public class GroupsSearchQuery
extends AbstractQueryBuilder<GroupsSearchQuery,SearchResponse>

Query for Groups.search method

Constructor Summary

Constructors

Constructor	Description
GroupsSearchQuery(VkApiClient client, UserActor actor, java.lang.String q)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Method Summary

Modifier and Type	Method	Description
GroupsSearchQuery	cityId(java.lang.Integer value)	City ID.
GroupsSearchQuery	count(java.lang.Integer value)	Number of communities to return.
GroupsSearchQuery	countryId(java.lang.Integer value)	Country ID.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
GroupsSearchQuery	future(java.lang.Boolean value)	'1' — to return only upcoming events.
protected GroupsSearchQuery	getThis()	Get reference to this object
GroupsSearchQuery	market(java.lang.Boolean value)	'1' — to return communities with enabled market only.
GroupsSearchQuery	offset(java.lang.Integer value)	Offset needed to return a specific subset of results.
protected GroupsSearchQuery	q(java.lang.String value)	Search query string.
GroupsSearchQuery	sort(SearchSort value)	Sort order.
GroupsSearchQuery	type(SearchType value)	Community type.

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

GroupsSearchQuery

public GroupsSearchQuery(VkApiClient client,
                         UserActor actor,
                         java.lang.String q)

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

q - value of "q" parameter.

Method Detail

q

protected GroupsSearchQuery q(java.lang.String value)

Search query string.

Parameters:

value - value of "q" parameter.

Returns:

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

type

public GroupsSearchQuery type(SearchType value)

Community type. Possible values: 'group, page, event.'

Parameters:

value - value of "type" parameter.

Returns:

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

countryId

public GroupsSearchQuery countryId(java.lang.Integer 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.

cityId

public GroupsSearchQuery cityId(java.lang.Integer value)

City ID. If this parameter is transmitted, country_id is ignored.

Parameters:

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

Returns:

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

future

public GroupsSearchQuery future(java.lang.Boolean value)

'1' — to return only upcoming events. Works with the 'type' = 'event' only.

Parameters:

value - value of "future" parameter.

Returns:

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

market

public GroupsSearchQuery market(java.lang.Boolean value)

'1' — to return communities with enabled market only.

Parameters:

value - value of "market" parameter.

Returns:

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

sort

public GroupsSearchQuery sort(SearchSort value)

Sort order. Possible values: *'0' — default sorting (similar the full version of the site),, *'1' — by growth speed,, *'2'— by the "day attendance/members number" ratio,, *'3' — by the "Likes number/members number" ratio,, *'4' — by the "comments number/members number" ratio,, *'5' — by the "boards entries number/members number" ratio.

Parameters:

value - value of "sort" parameter.

Returns:

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

offset

public GroupsSearchQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of results.

Parameters:

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

Returns:

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

count

public GroupsSearchQuery count(java.lang.Integer value)

Number of communities to return. "Note that you can not receive more than first thousand of results, regardless of 'count' and 'offset' values."

Parameters:

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

Returns:

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

getThis

protected GroupsSearchQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<GroupsSearchQuery,SearchResponse>

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<GroupsSearchQuery,SearchResponse>

Returns:

list of names