com.vk.api.sdk.queries.orders

Class OrdersChangeStateQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<OrdersChangeStateQuery,java.lang.String>

com.vk.api.sdk.queries.orders.OrdersChangeStateQuery

public class OrdersChangeStateQuery
extends AbstractQueryBuilder<OrdersChangeStateQuery,java.lang.String>

Query for Orders.changeState method

Constructor Summary

Constructors

Constructor and Description
OrdersChangeStateQuery(VkApiClient client, ServiceActor actor) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
OrdersChangeStateQuery(VkApiClient client, ServiceActor actor, java.lang.Integer orderId, ChangeStateAction action) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters

Method Summary

Modifier and Type	Method and Description
OrdersChangeStateQuery	action(ChangeStateAction value) Action to be done with the order.
OrdersChangeStateQuery	appOrderId(java.lang.Integer value) Internal ID of the order in the application.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected OrdersChangeStateQuery	getThis() Get reference to this object
OrdersChangeStateQuery	orderId(java.lang.Integer value) Order ID.
OrdersChangeStateQuery	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

OrdersChangeStateQuery

public OrdersChangeStateQuery(VkApiClient client,
                              ServiceActor actor,
                              java.lang.Integer orderId,
                              ChangeStateAction action)

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

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

action - value of "action" parameter.

OrdersChangeStateQuery

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

orderId

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

action

public OrdersChangeStateQuery action(ChangeStateAction value)

Action to be done with the order. Available actions: *cancel - to cancel unconfirmed order. *charge - to confirm unconfirmed order. Applies only if processing of [vk.com/dev/payments_status|order_change_state] notification failed. *refund - to cancel confirmed order.

Parameters:

value - value of "action" parameter.

Returns:

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

appOrderId

public OrdersChangeStateQuery appOrderId(java.lang.Integer value)

Internal ID of the order in the application.

Parameters:

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

Returns:

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

testMode

public OrdersChangeStateQuery 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 OrdersChangeStateQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<OrdersChangeStateQuery,java.lang.String>

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<OrdersChangeStateQuery,java.lang.String>

Returns:

list of names