com.vk.api.sdk.queries.market

Class MarketGetQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<MarketGetQuery,GetResponse>

com.vk.api.sdk.queries.market.MarketGetQuery

public class MarketGetQuery
extends AbstractQueryBuilder<MarketGetQuery,GetResponse>

Query for Market.get method

Constructor Summary

Constructors

Constructor and Description
MarketGetQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
MarketGetQuery(VkApiClient client, UserActor actor, java.lang.Long ownerId) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
MarketGetQuery	albumId(java.lang.Integer value) Set album id
MarketGetQuery	count(java.lang.Integer value) Number of items to return.
MarketGetQuery	dateFrom(java.lang.String value) Items update date from (format: yyyy-mm-dd)
MarketGetQuery	dateTo(java.lang.String value) Items update date to (format: yyyy-mm-dd)
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
MarketGetQuery	extended(java.lang.Boolean value) '1' - method will return additional fields: 'likes, can_comment, car_repost, photos'.
protected MarketGetQuery	getThis() Get reference to this object
MarketGetQuery	needVariants(java.lang.Boolean value) Add variants to response if exist
MarketGetQuery	offset(java.lang.Integer value) Offset needed to return a specific subset of results.
MarketGetQuery	ownerId(java.lang.Long value) ID of an item owner community, "Note that community id in the 'owner_id' parameter should be negative number.
MarketGetQuery	withDisabled(java.lang.Boolean value) Add disabled items to response

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

MarketGetQuery

public MarketGetQuery(VkApiClient client,
                      UserActor actor,
                      java.lang.Long ownerId)

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

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

MarketGetQuery

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

ownerId

public MarketGetQuery ownerId(java.lang.Long value)

ID of an item owner community, "Note that community id in the 'owner_id' parameter should be negative number. For example 'owner_id'=-1 matches the [vk.com/apiclub|VK API] community "

Parameters:

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

Returns:

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

albumId

public MarketGetQuery albumId(java.lang.Integer value)

Set album id

Parameters:

value - value of "album id" parameter. By default 0.

Returns:

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

count

public MarketGetQuery count(java.lang.Integer value)

Number of items to return.

Parameters:

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

Returns:

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

offset

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

extended

public MarketGetQuery extended(java.lang.Boolean value)

'1' - method will return additional fields: 'likes, can_comment, car_repost, photos'. These parameters are not returned by default.

Parameters:

value - value of "extended" parameter.

Returns:

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

dateFrom

public MarketGetQuery dateFrom(java.lang.String value)

Items update date from (format: yyyy-mm-dd)

Parameters:

value - value of "date from" parameter.

Returns:

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

dateTo

public MarketGetQuery dateTo(java.lang.String value)

Items update date to (format: yyyy-mm-dd)

Parameters:

value - value of "date to" parameter.

Returns:

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

needVariants

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

withDisabled

public MarketGetQuery withDisabled(java.lang.Boolean value)

Add disabled items to response

Parameters:

value - value of "with disabled" parameter.

Returns:

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

getThis

protected MarketGetQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MarketGetQuery,GetResponse>

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<MarketGetQuery,GetResponse>

Returns:

list of names