EOS_Ecom_QueryOwnershipToken

EOS API reference page for EOS_Ecom_QueryOwnershipToken

Choose your implementation method:

C

C#

This function is part of the Ecom Interface.

Remarks

Query the ownership status for a given list of catalog item IDs defined with Epic Online Services. The data is return via the callback in the form of a signed JWT that should be verified by an external backend server using a public key for authenticity.

Parameters

EOS_Ecom_QueryOwnershipToken

Parameter Type And Name

Usage Information

EOS_HEcom Handle

const EOS_Ecom_QueryOwnershipTokenOptions* Options

structure containing the account and catalog item IDs to retrieve in token form

void* ClientData

arbitrary data that is passed back to you in the CompletionDelegate

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

Callback Remarks

Function prototype definition for callbacks passed to EOS_Ecom_QueryOwnershipToken

Callback Parameters

EOS_Ecom_OnQueryOwnershipTokenCallback

Parameter Type And Name

Usage Information

const EOS_Ecom_QueryOwnershipTokenCallbackInfo* Data

A EOS_Ecom_QueryOwnershipTokenCallbackInfo containing the output information and result

Related API Members

This function is part of the Ecom Interface.

Remarks

Query the ownership status for a given list of catalog item IDs defined with Epic Online Services. The data is return via the callback in the form of a signed JWT that should be verified by an external backend server using a public key for authenticity.

Parameters

Ecom.EcomInterface.QueryOwnershipToken

Parameter Type And Name

Usage Information

QueryOwnershipTokenOptions options

structure containing the account and catalog item IDs to retrieve in token form

object clientData

arbitrary data that is passed back to you in the CompletionDelegate

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

Callback Remarks

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

Callback Parameters

Ecom.OnQueryOwnershipTokenCallback

Parameter Type And Name

Usage Information

QueryOwnershipTokenCallbackInfo data

A EOS_Ecom_QueryOwnershipTokenCallbackInfo containing the output information and result

Related API Members

Tags