host.anzo.eossdk.eos.sdk.ecom

Class EOS_Ecom_CatalogItem

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.ecom.EOS_Ecom_CatalogItem

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

EOS_Ecom_CatalogItem.ByReference, EOS_Ecom_CatalogItem.ByValue

@Structure.FieldOrder(value={"ApiVersion","CatalogNamespace","Id","EntitlementName","TitleText","DescriptionText","LongDescriptionText","TechnicalDetailsText","DeveloperText","ItemType","EntitlementEndTimestamp"})
public class EOS_Ecom_CatalogItem
extends com.sun.jna.Structure
implements java.lang.AutoCloseable

Contains information about a single item within the catalog. Instances of this structure are created by EOS_Ecom_Interface.copyOfferItemByIndex(EOS_Ecom_CopyOfferItemByIndexOptions).
They must be passed to release()

Since:

8/20/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_Ecom_CatalogItem.ByReference
static class	EOS_Ecom_CatalogItem.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_CATALOGITEM_API_LATEST.
java.lang.String	CatalogNamespace Product namespace in which this item exists
java.lang.String	DescriptionText Localized UTF-8 description of this item
java.lang.String	DeveloperText Localized UTF-8 developer of this item
long	EntitlementEndTimestamp If not -1 then this is the POSIX timestamp that the entitlement will end
java.lang.String	EntitlementName The entitlement name associated with this item
static int	EOS_ECOM_CATALOGITEM_API_LATEST The most recent version of the EOS_Ecom_CatalogItem struct.
static int	EOS_ECOM_CATALOGITEM_ENTITLEMENTENDTIMESTAMP_UNDEFINED Timestamp value representing an undefined EntitlementEndTimestamp for EOS_Ecom_CatalogItem
java.lang.String	Id The ID of this item
EOS_EEcomItemType	ItemType The type of item as defined in the catalog
java.lang.String	LongDescriptionText Localized UTF-8 long description of this item
java.lang.String	TechnicalDetailsText Localized UTF-8 technical details of this item
java.lang.String	TitleText Localized UTF-8 title of this item

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_CatalogItem()
EOS_Ecom_CatalogItem(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_CATALOGITEM_API_LATEST

public static final int EOS_ECOM_CATALOGITEM_API_LATEST

The most recent version of the EOS_Ecom_CatalogItem struct.

See Also:

Constant Field Values

EOS_ECOM_CATALOGITEM_ENTITLEMENTENDTIMESTAMP_UNDEFINED

public static final int EOS_ECOM_CATALOGITEM_ENTITLEMENTENDTIMESTAMP_UNDEFINED

Timestamp value representing an undefined EntitlementEndTimestamp for EOS_Ecom_CatalogItem

See Also:

Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_ECOM_CATALOGITEM_API_LATEST.

CatalogNamespace

public java.lang.String CatalogNamespace

Product namespace in which this item exists

Id

public java.lang.String Id

The ID of this item

EntitlementName

public java.lang.String EntitlementName

The entitlement name associated with this item

TitleText

public java.lang.String TitleText

Localized UTF-8 title of this item

DescriptionText

public java.lang.String DescriptionText

Localized UTF-8 description of this item

LongDescriptionText

public java.lang.String LongDescriptionText

Localized UTF-8 long description of this item

TechnicalDetailsText

public java.lang.String TechnicalDetailsText

Localized UTF-8 technical details of this item

DeveloperText

public java.lang.String DeveloperText

Localized UTF-8 developer of this item

ItemType

public EOS_EEcomItemType ItemType

The type of item as defined in the catalog

EntitlementEndTimestamp

public long EntitlementEndTimestamp

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

Constructor Detail

EOS_Ecom_CatalogItem

public EOS_Ecom_CatalogItem()

EOS_Ecom_CatalogItem

public EOS_Ecom_CatalogItem(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