AccelByte::Api::Order Class Reference

Order is used to purchase something from the online store. More...

#include <AccelByteOrderApi.h>

Inheritance diagram for AccelByte::Api::Order:

Public Member Functions
	Order (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient=nullptr)
	Order (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
FAccelByteTaskWPtr	CreateNewOrder (FAccelByteModelsOrderCreate const &OrderCreateRequest, THandler< FAccelByteModelsOrderInfo > const &OnSuccess, FErrorHandler const &OnError)
	Create order to purchase something from the store.
FAccelByteTaskWPtr	CancelOrder (FString const &OrderNo, THandler< FAccelByteModelsOrderInfo > const &OnSuccess, FErrorHandler const &OnError)
	Cancel Order after ord created with a specific Order number.
FAccelByteTaskWPtr	GetUserOrder (FString const &OrderNo, THandler< FAccelByteModelsOrderInfo > const &OnSuccess, FErrorHandler const &OnError)
	Get user's order information.
FAccelByteTaskWPtr	GetUserOrders (int32 Page, int32 Size, THandler< FAccelByteModelsPagedOrderInfo > const &OnSuccess, FErrorHandler const &OnError)
	Get all of user's orders that have been created with paging. @obsolete This method will be removed in the future, so please use QueryUserOrders(const FAccelByteModelsUserOrdersRequest& UserOrderRequest, const THandler<FAccelByteModelsPagedOrderInfo>& OnSuccess, const FErrorHandler& OnError);.
FAccelByteTaskWPtr	QueryUserOrders (FAccelByteModelsUserOrdersRequest const &UserOrderRequest, THandler< FAccelByteModelsPagedOrderInfo > const &OnSuccess, FErrorHandler const &OnError)
	Query all of user's orders that have been created with paging.
FAccelByteTaskWPtr	GetUserOrderHistory (FString const &OrderNo, THandler< TArray< FAccelByteModelsOrderHistoryInfo > > const &OnSuccess, FErrorHandler const &OnError)
	Get the history of the created orders.
FAccelByteTaskWPtr	PreviewUserOrder (FAccelByteModelsUserPreviewOrderRequest const &PreviewOrderRequest, THandler< FAccelByteModelsUserPreviewOrderResponse > const &OnSuccess, FErrorHandler const &OnError)
	Preview order price with discount code(s).
Public Member Functions inherited from AccelByte::FApiBase
	FApiBase (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient)
	FApiBase (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
void	SetApiClient (TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient)

Additional Inherited Members
Protected Member Functions inherited from AccelByte::FApiBase
template<typename T>
bool	ValidateAccelByteId (FString const &Id, EAccelByteIdHypensRule HypenRule, FString const &ErrorMessage, T const &OnError)
Protected Attributes inherited from AccelByte::FApiBase
TSharedRef< Credentials const, ESPMode::ThreadSafe >	CredentialsRef
Settings const &	SettingsRef
FHttpRetrySchedulerBase &	HttpRef
FHttpClient	HttpClient
FAccelBytePlatformPtr	AccelBytePlatformPtr

Detailed Description

Order is used to purchase something from the online store.

Member Function Documentation

CancelOrder()

FAccelByteTaskWPtr AccelByte::Api::Order::CancelOrder	(	FString const &	OrderNo,
		THandler< FAccelByteModelsOrderInfo > const &	OnSuccess,
		FErrorHandler const &	OnError )

Cancel Order after ord created with a specific Order number.

Parameters

OrderNo	Order number.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsOrderInfo.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

CreateNewOrder()

FAccelByteTaskWPtr AccelByte::Api::Order::CreateNewOrder	(	FAccelByteModelsOrderCreate const &	OrderCreateRequest,
		THandler< FAccelByteModelsOrderInfo > const &	OnSuccess,
		FErrorHandler const &	OnError )

Create order to purchase something from the store.

Parameters

OrderCreateRequest	Requst parameter.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsOrderInfo.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetUserOrder()

FAccelByteTaskWPtr AccelByte::Api::Order::GetUserOrder	(	FString const &	OrderNo,
		THandler< FAccelByteModelsOrderInfo > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get user's order information.

Parameters

OrderNo	Order number.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsOrderInfo.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetUserOrderHistory()

FAccelByteTaskWPtr AccelByte::Api::Order::GetUserOrderHistory	(	FString const &	OrderNo,
		THandler< TArray< FAccelByteModelsOrderHistoryInfo > > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get the history of the created orders.

Parameters

OrderNo	Order number.
OnSuccess	This will be called when the operation succeeded. The result is TArray<FAccelByteModelsOrderHistoryInfo>.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetUserOrders()

FAccelByteTaskWPtr AccelByte::Api::Order::GetUserOrders	(	int32	Page,
		int32	Size,
		THandler< FAccelByteModelsPagedOrderInfo > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get all of user's orders that have been created with paging. @obsolete This method will be removed in the future, so please use QueryUserOrders(const FAccelByteModelsUserOrdersRequest& UserOrderRequest, const THandler<FAccelByteModelsPagedOrderInfo>& OnSuccess, const FErrorHandler& OnError);.

Parameters

Page	Page number.
Size	Items per page.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsOrderInfoPaging.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

PreviewUserOrder()

FAccelByteTaskWPtr AccelByte::Api::Order::PreviewUserOrder	(	FAccelByteModelsUserPreviewOrderRequest const &	PreviewOrderRequest,
		THandler< FAccelByteModelsUserPreviewOrderResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Preview order price with discount code(s).

Parameters

PreviewOrderRequest	Preview order request.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUserPreviewOrderResponse.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

QueryUserOrders()

FAccelByteTaskWPtr AccelByte::Api::Order::QueryUserOrders	(	FAccelByteModelsUserOrdersRequest const &	UserOrderRequest,
		THandler< FAccelByteModelsPagedOrderInfo > const &	OnSuccess,
		FErrorHandler const &	OnError )

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

Parameters

UserOrderRequest	The request to query user orders, contains some parameters.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsOrderInfoPaging.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.