com.vk.api.sdk.queries.search

Class SearchGetHintsQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<SearchGetHintsQuery,GetHintsResponse>

com.vk.api.sdk.queries.search.SearchGetHintsQuery

public class SearchGetHintsQuery
extends AbstractQueryBuilder<SearchGetHintsQuery,GetHintsResponse>

Query for Search.getHints method

Constructor Summary

Constructors

Constructor and Description
SearchGetHintsQuery(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
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
SearchGetHintsQuery	fields(java.util.List<java.lang.String> value) Set fields
SearchGetHintsQuery	fields(java.lang.String... value) fields Set fields
SearchGetHintsQuery	filters(java.util.List<java.lang.String> value) Set filters
SearchGetHintsQuery	filters(java.lang.String... value) filters Set filters
protected SearchGetHintsQuery	getThis() Get reference to this object
SearchGetHintsQuery	limit(java.lang.Integer value) Maximum number of results to return.
SearchGetHintsQuery	offset(java.lang.Integer value) Offset for querying specific result subset
SearchGetHintsQuery	q(java.lang.String value) Search query string.
SearchGetHintsQuery	searchGlobal(java.lang.Boolean value) Set search global

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

SearchGetHintsQuery

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

q

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

offset

public SearchGetHintsQuery offset(java.lang.Integer value)

Offset for querying specific result subset

Parameters:

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

Returns:

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

limit

public SearchGetHintsQuery limit(java.lang.Integer value)

Maximum number of results to return.

Parameters:

value - value of "limit" parameter. Maximum is 200. Minimum is 0. By default 9.

Returns:

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

searchGlobal

public SearchGetHintsQuery searchGlobal(java.lang.Boolean value)

Set search global

Parameters:

value - value of "search global" parameter. By default true.

Returns:

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

filters

public SearchGetHintsQuery filters(java.lang.String... value)

filters Set filters

Parameters:

value - value of "filters" parameter.

Returns:

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

filters

public SearchGetHintsQuery filters(java.util.List<java.lang.String> value)

Set filters

Parameters:

value - value of "filters" parameter.

Returns:

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

fields

public SearchGetHintsQuery fields(java.lang.String... value)

fields Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

public SearchGetHintsQuery fields(java.util.List<java.lang.String> value)

Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected SearchGetHintsQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<SearchGetHintsQuery,GetHintsResponse>

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<SearchGetHintsQuery,GetHintsResponse>

Returns:

list of names