Package com.vk.api.sdk.queries.orders

Class OrdersGetByIdQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<OrdersGetByIdQuery,java.util.List<GetByIdResponse>>

com.vk.api.sdk.queries.orders.OrdersGetByIdQuery

public class OrdersGetByIdQuery
extends AbstractQueryBuilder<OrdersGetByIdQuery,java.util.List<GetByIdResponse>>

Query for Orders.getById method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected OrdersGetByIdQuery	getThis()	Get reference to this object
OrdersGetByIdQuery	orderId(java.lang.Integer value)	Order ID.
OrdersGetByIdQuery	orderIds(java.lang.Integer... value)	order_ids Order IDs (when information about several orders is requested).
OrdersGetByIdQuery	orderIds(java.util.List<java.lang.Integer> value)	Order IDs (when information about several orders is requested).
OrdersGetByIdQuery	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, 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

OrdersGetByIdQuery

public OrdersGetByIdQuery(VkApiClient client,
                          ServiceActor actor)

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

Method Detail

orderId

public OrdersGetByIdQuery orderId(java.lang.Integer value)

Order ID.

Parameters:

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

Returns:

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

testMode

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

orderIds

public OrdersGetByIdQuery orderIds(java.lang.Integer... value)

order_ids Order IDs (when information about several orders is requested).

Parameters:

value - value of "order ids" parameter.

Returns:

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

orderIds

public OrdersGetByIdQuery orderIds(java.util.List<java.lang.Integer> value)

Order IDs (when information about several orders is requested).

Parameters:

value - value of "order ids" parameter.

Returns:

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

getThis

protected OrdersGetByIdQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<OrdersGetByIdQuery,java.util.List<GetByIdResponse>>

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<OrdersGetByIdQuery,java.util.List<GetByIdResponse>>

Returns:

list of names