com.vk.api.sdk.queries.wall

Class WallSearchQuery

java.lang.Object

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

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

com.vk.api.sdk.queries.wall.WallSearchQuery

public class WallSearchQuery
extends AbstractQueryBuilder<WallSearchQuery,SearchResponse>

Query for Wall.search method

Constructor Summary

Constructors

Constructor and Description
WallSearchQuery(VkApiClient client, ServiceActor actor) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
WallSearchQuery(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
WallSearchQuery	count(java.lang.Integer value) Count of posts to return.
WallSearchQuery	domain(java.lang.String value) User or community screen name.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
WallSearchQuery	extended(java.lang.Boolean value) Show extended post info.
WallSearchQuery	fields(java.util.List<UserGroupFields> value) Set fields
WallSearchQuery	fields(UserGroupFields... value) fields Set fields
protected WallSearchQuery	getThis() Get reference to this object
WallSearchQuery	offset(java.lang.Integer value) Offset needed to return a specific subset of posts.
WallSearchQuery	ownerId(java.lang.Long value) User or community id.
WallSearchQuery	ownersOnly(java.lang.Boolean value) '1' - returns only page owner's posts.
WallSearchQuery	query(java.lang.String value) Search query string.

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

WallSearchQuery

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

WallSearchQuery

public WallSearchQuery(VkApiClient client,
                       ServiceActor actor)

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

Parameters:

client - VK API client

actor - actor with access token

Method Detail

ownerId

public WallSearchQuery ownerId(java.lang.Long value)

User or community id. "Remember that for a community 'owner_id' must be negative."

Parameters:

value - value of "owner id" parameter. Entity - owner

Returns:

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

domain

public WallSearchQuery domain(java.lang.String value)

User or community screen name.

Parameters:

value - value of "domain" parameter.

Returns:

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

query

public WallSearchQuery query(java.lang.String value)

Search query string.

Parameters:

value - value of "query" parameter.

Returns:

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

ownersOnly

public WallSearchQuery ownersOnly(java.lang.Boolean value)

'1' - returns only page owner's posts.

Parameters:

value - value of "owners only" parameter.

Returns:

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

count

public WallSearchQuery count(java.lang.Integer value)

Count of posts to return.

Parameters:

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

Returns:

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

offset

public WallSearchQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of posts.

Parameters:

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

Returns:

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

extended

public WallSearchQuery extended(java.lang.Boolean value)

Show extended post info.

Parameters:

value - value of "extended" parameter.

Returns:

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

fields

public WallSearchQuery fields(UserGroupFields... value)

fields Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

public WallSearchQuery fields(java.util.List<UserGroupFields> value)

Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected WallSearchQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

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

Returns:

list of names