AccelByte.Api.Orders Class Reference

Provide an API to access service related to user orders. More...

Inheritance diagram for AccelByte.Api.Orders:

Public Member Functions
void	CreateOrder (OrderRequest orderRequest, ResultCallback< OrderInfo > callback)
	Create an order to purchase an item.
void	CancelOrder (string orderNo, ResultCallback< OrderInfo > callback)
	Cancel the Order after Create the Order.
void	GetUserOrder (string orderNo, ResultCallback< OrderInfo > callback)
	Get a specific order by orderNo.
void	GetUserOrders (uint startPage, uint size, ResultCallback< OrderPagingSlicedResult > callback)
	Get all orders limited by paging parameters. Returns a list of OrderInfo contained by a page. This Function is obsolete, please use QueryUserOrders(UserOrderRequest userOrderRequest, ResultCallback<OrderPagingSlicedResult> callback) instead.
void	GetUserOrderHistory (string orderNo, ResultCallback< OrderHistoryInfo[]> callback)
	Get history of an order specified by orderNo.
void	QueryUserOrders (UserOrdersRequest userOrderRequest, ResultCallback< OrderPagingSlicedResult > callback)
	Get all of user's orders that have been created with paging.
void	PreviewOrderPriceWithDiscountCode (string itemId, int quantity, int price, int discountedPrice, string currencyCode, string[] discountCodes, ResultCallback< OrderDiscountPreviewResponse > callback)
	Preview order price with discount code, this api is used to auto calc order price with discount code. Notes: this api don't do full order validation, only check discount code and calc final order price.

Additional Inherited Members
Properties inherited from AccelByte.Core.WrapperBase
Utils.AccelByteIdValidator	IdValidator [get]

Detailed Description

Provide an API to access service related to user orders.

Member Function Documentation

CancelOrder()

void AccelByte.Api.Orders.CancelOrder ( string orderNo, ResultCallback< OrderInfo > callback )

inline

Cancel the Order after Create the Order.

Parameters

orderNo	need orderNo parameter to cancel the payment
callback	callback delegate that will send the OrderInfo models parameter value

CreateOrder()

void AccelByte.Api.Orders.CreateOrder ( OrderRequest orderRequest, ResultCallback< OrderInfo > callback )

inline

Create an order to purchase an item.

Parameters

orderRequest	Details about order to be created
callback	Returns a Result that contains OrderInfo via callback when completed

GetUserOrder()

void AccelByte.Api.Orders.GetUserOrder ( string orderNo, ResultCallback< OrderInfo > callback )

inline

Get a specific order by orderNo.

Parameters

orderNo	Order number
callback	Returns a Result that contains OrderInfo via callback when completed

GetUserOrderHistory()

void AccelByte.Api.Orders.GetUserOrderHistory ( string orderNo, ResultCallback< OrderHistoryInfo[]> callback )

inline

Get history of an order specified by orderNo.

Parameters

orderNo	Order number
callback	Returns a Result that contains OrderHistoryInfo array via callback when completed.

GetUserOrders()

void AccelByte.Api.Orders.GetUserOrders ( uint startPage, uint size, ResultCallback< OrderPagingSlicedResult > callback )

inline

Get all orders limited by paging parameters. Returns a list of OrderInfo contained by a page. This Function is obsolete, please use QueryUserOrders(UserOrderRequest userOrderRequest, ResultCallback<OrderPagingSlicedResult> callback) instead.

Parameters

startPage	Page number
size	Size of each page
callback	Returns a Result that contains OrderPagingSlicedResult via callback when completed

PreviewOrderPriceWithDiscountCode()

void AccelByte.Api.Orders.PreviewOrderPriceWithDiscountCode ( string itemId, int quantity, int price, int discountedPrice, string currencyCode, string[] discountCodes, ResultCallback< OrderDiscountPreviewResponse > callback )

inline

Preview order price with discount code, this api is used to auto calc order price with discount code. Notes: this api don't do full order validation, only check discount code and calc final order price.

Parameters

itemId	Item id
quantity	Item quantity
price	Item price
discountedPrice	Item discounted price
currencyCode	Currency code
discountCodes	List of discount code to apply
callback	Returns a Result that contains OrderDiscountPreviewResponse via callback when completed.

QueryUserOrders()

void AccelByte.Api.Orders.QueryUserOrders ( UserOrdersRequest userOrderRequest, ResultCallback< OrderPagingSlicedResult > callback )

inline

Get all of user's orders that have been created with paging.

Parameters

userOrderRequest	Contains some parameters for query
callback	Returns a Result that contains OrderPagingSlicedResult via callback when completed.