com.vk.api.sdk.queries.docs

Class DocsSearchQuery

java.lang.Object

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

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

com.vk.api.sdk.queries.docs.DocsSearchQuery

public class DocsSearchQuery
extends AbstractQueryBuilder<DocsSearchQuery,SearchResponse>

Query for Docs.search method

Constructor Summary

Constructors

Constructor and Description
DocsSearchQuery(VkApiClient client, GroupActor actor) Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
DocsSearchQuery(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
DocsSearchQuery	count(java.lang.Integer value) Number of results to return.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected DocsSearchQuery	getThis() Get reference to this object
DocsSearchQuery	offset(java.lang.Integer value) Offset needed to return a specific subset of results.
DocsSearchQuery	q(java.lang.String value) Search query string.
DocsSearchQuery	returnTags(java.lang.Boolean value) Set return tags
DocsSearchQuery	searchOwn(java.lang.Boolean value) Set search own

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

DocsSearchQuery

public DocsSearchQuery(VkApiClient client,
                       GroupActor actor)

Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

DocsSearchQuery

public DocsSearchQuery(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 DocsSearchQuery 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.

searchOwn

public DocsSearchQuery searchOwn(java.lang.Boolean value)

Set search own

Parameters:

value - value of "search own" parameter.

Returns:

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

count

public DocsSearchQuery count(java.lang.Integer value)

Number of results to return.

Parameters:

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

Returns:

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

offset

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

returnTags

public DocsSearchQuery returnTags(java.lang.Boolean value)

Set return tags

Parameters:

value - value of "return tags" parameter.

Returns:

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

getThis

protected DocsSearchQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<DocsSearchQuery,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<DocsSearchQuery,SearchResponse>

Returns:

list of names