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:

java.lang.AutoCloseable

Direct Known Subclasses:

EOS_Ecom_Entitlement.ByReference, EOS_Ecom_Entitlement.ByValue

@Structure.FieldOrder(value={"ApiVersion","EntitlementName","EntitlementId","CatalogItemId","ServerIndex","IsRedeemed","EndTimestamp"})
public class EOS_Ecom_Entitlement
extends com.sun.jna.Structure
implements java.lang.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 Classes

Modifier and Type	Class and Description
static class	EOS_Ecom_Entitlement.ByReference
static class	EOS_Ecom_Entitlement.ByValue

Nested classes/interfaces inherited from class com.sun.jna.Structure

com.sun.jna.Structure.FieldOrder, com.sun.jna.Structure.StructField

Field Summary

Fields

Modifier and Type	Field and Description
int	ApiVersion API Version: Set this to EOS_ECOM_ENTITLEMENT_API_LATEST.
java.lang.String	CatalogItemId ID of the item associated with the offer which granted this entitlement
long	EndTimestamp If not -1 then this is a POSIX timestamp that this entitlement will end
java.lang.String	EntitlementId ID of the entitlement owned by an account
java.lang.String	EntitlementName Name of the entitlement
static int	EOS_ECOM_ENTITLEMENT_API_LATEST The most recent version of the EOS_Ecom_Entitlement struct.
static int	EOS_ECOM_ENTITLEMENT_ENDTIMESTAMP_UNDEFINED Timestamp value representing an undefined EndTimestamp for EOS_Ecom_Entitlement
EOS_Bool	IsRedeemed If true then the catalog has this entitlement marked as redeemed
int	ServerIndex 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

Constructor and Description
EOS_Ecom_Entitlement()
EOS_Ecom_Entitlement(com.sun.jna.Pointer peer)

Method Summary

Modifier and Type	Method and Description
void	close()
void	release()

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EOS_ECOM_ENTITLEMENT_API_LATEST

public static final int EOS_ECOM_ENTITLEMENT_API_LATEST

The most recent version of the EOS_Ecom_Entitlement struct.

See Also:

Constant Field Values

EOS_ECOM_ENTITLEMENT_ENDTIMESTAMP_UNDEFINED

public static final int EOS_ECOM_ENTITLEMENT_ENDTIMESTAMP_UNDEFINED

Timestamp value representing an undefined EndTimestamp for EOS_Ecom_Entitlement

See Also:

Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_ECOM_ENTITLEMENT_API_LATEST.

EntitlementName

public java.lang.String EntitlementName

Name of the entitlement

EntitlementId

public java.lang.String EntitlementId

ID of the entitlement owned by an account

CatalogItemId

public java.lang.String CatalogItemId

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

ServerIndex

public 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.

IsRedeemed

public EOS_Bool IsRedeemed

If true then the catalog has this entitlement marked as redeemed

EndTimestamp

public long EndTimestamp

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

Constructor Detail

EOS_Ecom_Entitlement

public EOS_Ecom_Entitlement()

EOS_Ecom_Entitlement

public EOS_Ecom_Entitlement(com.sun.jna.Pointer peer)

Method Detail

release

public void release()

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception