com.vk.api.sdk.queries.orders

Class OrdersGetQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<OrdersGetQuery,java.util.List<GetResponse>>

com.vk.api.sdk.queries.orders.OrdersGetQuery

public class OrdersGetQuery
extends AbstractQueryBuilder<OrdersGetQuery,java.util.List<GetResponse>>

Query for Orders.get method

Constructor Summary

Constructors

Constructor and Description
OrdersGetQuery(VkApiClient client, ServiceActor actor) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters

Method Summary

Modifier and Type	Method and Description
OrdersGetQuery	count(java.lang.Integer value) Number of returned orders.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected OrdersGetQuery	getThis() Get reference to this object
OrdersGetQuery	offset(java.lang.Integer value) Set offset
OrdersGetQuery	testMode(java.lang.Boolean value) If this parameter is set to 1, this method returns a list of test mode orders.

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

OrdersGetQuery

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

offset

public OrdersGetQuery offset(java.lang.Integer value)

Set offset

Parameters:

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

Returns:

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

count

public OrdersGetQuery count(java.lang.Integer value)

Number of returned orders.

Parameters:

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

Returns:

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

testMode

public OrdersGetQuery testMode(java.lang.Boolean value)

If this parameter is set to 1, this method returns a list of test mode orders. By default - 0.

Parameters:

value - value of "test mode" parameter.

Returns:

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

getThis

protected OrdersGetQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<OrdersGetQuery,java.util.List<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<OrdersGetQuery,java.util.List<GetResponse>>

Returns:

list of names