EOS_Ecom_Entitlement

EOS API reference page for EOS_Ecom_Entitlement

Choose your implementation method:

C

C#

This data structure is part of the Ecom Interface.

Remarks

Contains information about a single entitlement associated with an account. Instances of this structure are created by EOS_Ecom_CopyEntitlementByIndex, EOS_Ecom_CopyEntitlementByNameAndIndex, or EOS_Ecom_CopyEntitlementById. They must be passed to EOS_Ecom_Entitlement_Release.

Properties

EOS_Ecom_Entitlement

Property

Value

int32_t ApiVersion

API Version: Set this to EOS_ECOM_ENTITLEMENT_API_LATEST.

EOS_Ecom_EntitlementName EntitlementName

Name of the entitlement

EOS_Ecom_EntitlementId EntitlementId

ID of the entitlement owned by an account

EOS_Ecom_CatalogItemId CatalogItemId

ID of the item associated with the offer which granted this entitlement

int32_t ServerIndex

If queried using pagination then ServerIndex represents the index of the entitlement as it exists on the server. If not queried using pagination then ServerIndex will be -1.

EOS_Bool bRedeemed

If true then the catalog has this entitlement marked as redeemed

int64_t EndTimestamp

If not -1 then this is a POSIX timestamp that this entitlement will end

Related API Members

This data structure is part of the Ecom Interface.

Remarks

Contains information about a single entitlement associated with an account. Instances of this structure are created by {EcomInterface.CopyEntitlementByIndex}, {EcomInterface.CopyEntitlementByNameAndIndex}, or {EcomInterface.CopyEntitlementById}. They must be passed to {EcomInterface.Release}.

Properties

Ecom.Entitlement

Property

Value

int ApiVersion

API Version: Set this to EOS_ECOM_ENTITLEMENT_API_LATEST.

string EntitlementName

Name of the entitlement

string EntitlementId

ID of the entitlement owned by an account

string CatalogItemId

ID of the item associated with the offer which granted this entitlement

int ServerIndex

If queried using pagination then ServerIndex represents the index of the entitlement as it exists on the server. If not queried using pagination then ServerIndex will be -1.

bool Redeemed

If true then the catalog has this entitlement marked as redeemed

long EndTimestamp

If not -1 then this is a POSIX timestamp that this entitlement will end

Related API Members

Tags