Package host.anzo.eossdk.eos.sdk.ecom
Class EOS_Ecom_Entitlement
java.lang.Object
com.sun.jna.Structure
host.anzo.eossdk.eos.sdk.ecom.EOS_Ecom_Entitlement
- All Implemented Interfaces:
AutoCloseable
- Direct Known Subclasses:
EOS_Ecom_Entitlement.ByReference
,EOS_Ecom_Entitlement.ByValue
@FieldOrder({"ApiVersion","EntitlementName","EntitlementId","CatalogItemId","ServerIndex","bRedeemed","EndTimestamp"})
public class EOS_Ecom_Entitlement
extends com.sun.jna.Structure
implements AutoCloseable
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.
- Since:
- 8/20/2023
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static class
Nested classes/interfaces inherited from class com.sun.jna.Structure
com.sun.jna.Structure.FieldOrder, com.sun.jna.Structure.StructField
-
Field Summary
FieldsModifier and TypeFieldDescriptionint
API Version: Set this to EOS_ECOM_ENTITLEMENT_API_LATEST.int
If true then the catalog has this entitlement marked as redeemedID of the item associated with the offer which granted this entitlementlong
If not -1 then this is a POSIX timestamp that this entitlement will endID of the entitlement owned by an accountName of the entitlementstatic final int
The most recent version of the EOS_Ecom_Entitlement struct.static final int
Timestamp value representing an undefined EndTimestamp for EOS_Ecom_Entitlementint
If queried using pagination then ServerIndex represents the index of the entitlement as it exists on the server.Fields inherited from class com.sun.jna.Structure
ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE
-
Constructor Summary
Constructors -
Method Summary
Methods inherited from class com.sun.jna.Structure
allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, createFieldsOrder, createFieldsOrder, createFieldsOrder, createFieldsOrder, dataEquals, dataEquals, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFieldOrder, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, read, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField
-
Field Details
-
EOS_ECOM_ENTITLEMENT_API_LATEST
public static final int EOS_ECOM_ENTITLEMENT_API_LATESTThe most recent version of the EOS_Ecom_Entitlement struct.- See Also:
-
EOS_ECOM_ENTITLEMENT_ENDTIMESTAMP_UNDEFINED
public static final int EOS_ECOM_ENTITLEMENT_ENDTIMESTAMP_UNDEFINEDTimestamp value representing an undefined EndTimestamp for EOS_Ecom_Entitlement- See Also:
-
ApiVersion
public int ApiVersionAPI Version: Set this to EOS_ECOM_ENTITLEMENT_API_LATEST. -
EntitlementName
Name of the entitlement -
EntitlementId
ID of the entitlement owned by an account -
CatalogItemId
ID of the item associated with the offer which granted this entitlement -
ServerIndex
public int ServerIndexIf 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. -
bRedeemed
public int bRedeemedIf true then the catalog has this entitlement marked as redeemed -
EndTimestamp
public long EndTimestampIf not -1 then this is a POSIX timestamp that this entitlement will end
-
-
Constructor Details
-
EOS_Ecom_Entitlement
public EOS_Ecom_Entitlement() -
EOS_Ecom_Entitlement
public EOS_Ecom_Entitlement(com.sun.jna.Pointer peer)
-
-
Method Details
-
release
public void release() -
close
- Specified by:
close
in interfaceAutoCloseable
- Throws:
Exception
-