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

Class MarketGetQueryWithExtended

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<MarketGetQueryWithExtended,GetExtendedResponse>

com.vk.api.sdk.queries.market.MarketGetQueryWithExtended

public class MarketGetQueryWithExtended
extends AbstractQueryBuilder<MarketGetQueryWithExtended,GetExtendedResponse>

Query for Market.get method

Constructor Summary

Constructors

Constructor	Description
MarketGetQueryWithExtended(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
MarketGetQueryWithExtended	albumId(java.lang.Integer value)	Set album id
MarketGetQueryWithExtended	count(java.lang.Integer value)	Number of items to return.
MarketGetQueryWithExtended	dateFrom(java.lang.String value)	Items update date from (format: yyyy-mm-dd)
MarketGetQueryWithExtended	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
protected MarketGetQueryWithExtended	extended(java.lang.Boolean value)	'1' - method will return additional fields: 'likes, can_comment, car_repost, photos'.
protected MarketGetQueryWithExtended	getThis()	Get reference to this object
MarketGetQueryWithExtended	needVariants(java.lang.Boolean value)	Add variants to response if exist
MarketGetQueryWithExtended	offset(java.lang.Integer value)	Offset needed to return a specific subset of results.
protected MarketGetQueryWithExtended	ownerId(int value)	ID of an item owner community, "Note that community id in the 'owner_id' parameter should be negative number.
MarketGetQueryWithExtended	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, 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

MarketGetQueryWithExtended

public MarketGetQueryWithExtended(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 MarketGetQueryWithExtended ownerId(int 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.

Returns:

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

albumId

public MarketGetQueryWithExtended albumId(java.lang.Integer value)

Set album id

Parameters:

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

Returns:

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

count

public MarketGetQueryWithExtended 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 MarketGetQueryWithExtended 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

protected MarketGetQueryWithExtended 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 MarketGetQueryWithExtended 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 MarketGetQueryWithExtended 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 MarketGetQueryWithExtended 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 MarketGetQueryWithExtended 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 MarketGetQueryWithExtended getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MarketGetQueryWithExtended,GetExtendedResponse>

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<MarketGetQueryWithExtended,GetExtendedResponse>

Returns:

list of names