EOS API reference page for EOS_Ecom_Checkout

This function is part of the Ecom Interface.


Initiates the purchase flow for a set of offers. The callback is triggered after the purchase flow. On success, the set of entitlements that were unlocked will be cached. On success, a Transaction ID will be returned. The Transaction ID can be used to obtain an EOS_Ecom_HTransaction handle. The handle can then be used to retrieve the entitlements rewarded by the purchase.

See Also



Parameter Type And Name

Usage Information

EOS_HEcom Handle

const EOS_Ecom_CheckoutOptions* Options

structure containing filter criteria

void* ClientData

arbitrary data that is passed back to you in the CompletionDelegate

const EOS_Ecom_OnCheckoutCallback CompletionDelegate

a callback that is fired when the async operation completes, either successfully or in error

This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the void* parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.

Callback Function Information

Because this function is asynchronous, it employs a callback of type EOS_Ecom_OnCheckoutCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_Ecom_Checkout

Callback Parameters

Parameter Type And Name

Usage Information

const EOS_Ecom_CheckoutCallbackInfo* Data

A EOS_Ecom_CheckoutCallbackInfo containing the output information and result

Related API Members