EOS_Ecom_QueryOffers

EOS API reference page for EOS_Ecom_QueryOffers

Choose your implementation method:

C

C#

This function is part of the Ecom Interface.

Remarks

Query for a list of catalog offers defined with Epic Online Services. This data will be cached for a limited time and retrieved again from the backend when necessary.

Parameters

EOS_Ecom_QueryOffers

Parameter Type And Name

Usage Information

EOS_HEcom Handle

const EOS_Ecom_QueryOffersOptions* Options

structure containing filter criteria

void* ClientData

arbitrary data that is passed back to you in the CompletionDelegate

const EOS_Ecom_OnQueryOffersCallback 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_OnQueryOffersCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_Ecom_QueryOffers

Callback Parameters

EOS_Ecom_OnQueryOffersCallback

Parameter Type And Name

Usage Information

const EOS_Ecom_QueryOffersCallbackInfo* Data

A EOS_Ecom_QueryOffersCallbackInfo containing the output information and result

Related API Members

This function is part of the Ecom Interface.

Remarks

Query for a list of catalog offers defined with Epic Online Services. This data will be cached for a limited time and retrieved again from the backend when necessary.

Parameters

Ecom.EcomInterface.QueryOffers

Parameter Type And Name

Usage Information

QueryOffersOptions options

structure containing filter criteria

object clientData

arbitrary data that is passed back to you in the CompletionDelegate

OnQueryOffersCallback 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 object 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 Ecom.OnQueryOffersCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to {EcomInterface.QueryOffers}

Callback Parameters

Ecom.OnQueryOffersCallback

Parameter Type And Name

Usage Information

QueryOffersCallbackInfo data

A EOS_Ecom_QueryOffersCallbackInfo containing the output information and result

Related API Members

Tags