Package com.vk.api.sdk.queries.market

Class MarketSearchQuery

java.lang.Object

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

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

com.vk.api.sdk.queries.market.MarketSearchQuery

public class MarketSearchQuery
extends AbstractQueryBuilder<MarketSearchQuery,SearchResponse>

Query for Market.search method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
MarketSearchQuery	albumId(java.lang.Integer value)	Set album id
MarketSearchQuery	count(java.lang.Integer value)	Number of items to return.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
MarketSearchQuery	extended(java.lang.Boolean value)	'1' - to return additional fields: 'likes, can_comment, car_repost, photos'.
protected MarketSearchQuery	getThis()	Get reference to this object
MarketSearchQuery	needVariants(java.lang.Boolean value)	Add variants to response if exist
MarketSearchQuery	offset(java.lang.Integer value)	Offset needed to return a specific subset of results.
protected MarketSearchQuery	ownerId(int value)	ID of an items owner community.
MarketSearchQuery	priceFrom(java.lang.Integer value)	Minimum item price value.
MarketSearchQuery	priceTo(java.lang.Integer value)	Maximum item price value.
MarketSearchQuery	q(java.lang.String value)	Search query, for example "pink slippers".
MarketSearchQuery	rev(SearchRev value)	'0' — do not use reverse order, '1' — use reverse order
MarketSearchQuery	sort(SearchSort value)	Set sort
MarketSearchQuery	status(SearchStatus value)	Set status

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

MarketSearchQuery

public MarketSearchQuery(VkApiClient client,
                         UserActor actor,
                         int ownerId)

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

ownerId - value of "owner id" parameter.

Method Detail

ownerId

protected MarketSearchQuery ownerId(int value)

ID of an items owner community.

Parameters:

value - value of "owner id" parameter.

Returns:

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

albumId

public MarketSearchQuery albumId(java.lang.Integer value)

Set album id

Parameters:

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

Returns:

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

q

public MarketSearchQuery q(java.lang.String value)

Search query, for example "pink slippers".

Parameters:

value - value of "q" parameter.

Returns:

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

priceFrom

public MarketSearchQuery priceFrom(java.lang.Integer value)

Minimum item price value.

Parameters:

value - value of "price from" parameter. Minimum is 0.

Returns:

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

priceTo

public MarketSearchQuery priceTo(java.lang.Integer value)

Maximum item price value.

Parameters:

value - value of "price to" parameter. Minimum is 0.

Returns:

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

sort

public MarketSearchQuery sort(SearchSort value)

Set sort

Parameters:

value - value of "sort" parameter. By default 0.

Returns:

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

rev

public MarketSearchQuery rev(SearchRev value)

'0' — do not use reverse order, '1' — use reverse order

Parameters:

value - value of "rev" parameter. Minimum is 0. By default 1.

Returns:

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

offset

public MarketSearchQuery 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 MarketSearchQuery count(java.lang.Integer value)

Number of items to return.

Parameters:

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

Returns:

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

extended

public MarketSearchQuery extended(java.lang.Boolean value)

'1' - to return additional fields: 'likes, can_comment, car_repost, photos'. By default: '0'.

Parameters:

value - value of "extended" parameter. By default 0.

Returns:

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

status

public MarketSearchQuery status(SearchStatus value)

Set status

Parameters:

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

Returns:

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

needVariants

public MarketSearchQuery needVariants(java.lang.Boolean value)

Add variants to response if exist

Parameters:

value - value of "need variants" parameter.

Returns:

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

getThis

protected MarketSearchQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

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

Returns:

list of names