EOS_Ecom_QueryEntitlements

EOS API reference page for EOS_Ecom_QueryEntitlements

Choose your implementation method:

C

C#

This function is part of the Ecom Interface.

Remarks

Query the entitlement information defined with Epic Online Services. A set of entitlement names can be provided to filter the set of entitlements associated with the account. This data will be cached for a limited time and retrieved again from the backend when necessary. Use EOS_Ecom_CopyEntitlementByIndex, EOS_Ecom_CopyEntitlementByNameAndIndex, and EOS_Ecom_CopyEntitlementById to get the entitlement details. Use EOS_Ecom_GetEntitlementsByNameCount to retrieve the number of entitlements with a specific entitlement name.

Parameters

EOS_Ecom_QueryEntitlements

Parameter Type And Name

Usage Information

EOS_HEcom Handle

const EOS_Ecom_QueryEntitlementsOptions* Options

structure containing the account and entitlement names to retrieve

void* ClientData

arbitrary data that is passed back to you in the CompletionDelegate

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

Callback Remarks

Function prototype definition for callbacks passed to EOS_Ecom_QueryOwnershipToken

Callback Parameters

EOS_Ecom_OnQueryEntitlementsCallback

Parameter Type And Name

Usage Information

const EOS_Ecom_QueryEntitlementsCallbackInfo* Data

A EOS_Ecom_QueryEntitlementsCallbackInfo containing the output information and result

Related API Members

This function is part of the Ecom Interface.

Remarks

Query the entitlement information defined with Epic Online Services. A set of entitlement names can be provided to filter the set of entitlements associated with the account. This data will be cached for a limited time and retrieved again from the backend when necessary. Use {CopyEntitlementByIndex}, {CopyEntitlementByNameAndIndex}, and {CopyEntitlementById} to get the entitlement details. Use {GetEntitlementsByNameCount} to retrieve the number of entitlements with a specific entitlement name.

Parameters

Ecom.EcomInterface.QueryEntitlements

Parameter Type And Name

Usage Information

QueryEntitlementsOptions options

structure containing the account and entitlement names to retrieve

object clientData

arbitrary data that is passed back to you in the CompletionDelegate

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

Callback Remarks

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

Callback Parameters

Ecom.OnQueryEntitlementsCallback

Parameter Type And Name

Usage Information

QueryEntitlementsCallbackInfo data

A EOS_Ecom_QueryEntitlementsCallbackInfo containing the output information and result

Related API Members

Tags