Package host.anzo.eossdk.eos.sdk.ecom

Class EOS_Ecom_CatalogOffer

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.ecom.EOS_Ecom_CatalogOffer

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

EOS_Ecom_CatalogOffer.ByReference, EOS_Ecom_CatalogOffer.ByValue

@FieldOrder({"ApiVersion","ServerIndex","CatalogNamespace","Id","TitleText","DescriptionText","LongDescriptionText","TechnicalDetailsText_DEPRECATED","CurrencyCode","PriceResult","OriginalPrice_DEPRECATED","CurrentPrice_DEPRECATED","DiscountPercentage","ExpirationTimestamp","PurchasedCount_DEPRECATED","PurchaseLimit","IsAvailableForPurchase","OriginalPrice64","CurrentPrice64","DecimalPoint","ReleaseDateTimestamp","EffectiveDateTimestamp"})
public class EOS_Ecom_CatalogOffer
extends com.sun.jna.Structure
implements AutoCloseable

Contains information about a single offer within the catalog. Instances of this structure are created by EOS_Ecom_CopyOfferByIndex. They must be passed to EOS_Ecom_CatalogOffer_Release. Prices are stored in the lowest denomination for the associated currency. If CurrencyCode is "USD" then a price of 299 represents "$2.99".

Since:

8/20/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EOS_Ecom_CatalogOffer.ByReference
static class	EOS_Ecom_CatalogOffer.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	Description
int	ApiVersion	API Version: Set this to EOS_ECOM_CATALOGOFFER_API_LATEST.
String	CatalogNamespace	Product namespace in which this offer exists
String	CurrencyCode	The Currency Code for this offer
int	CurrentPrice_DEPRECATED	The current price including discounts of this offer as a 32-bit number is deprecated..
long	CurrentPrice64	The current price including discounts of this offer as a 64-bit number.
int	DecimalPoint	The decimal point for the provided price.
String	DescriptionText	Localized UTF-8 description of this offer
byte	DiscountPercentage	A value from 0 to 100 define the percentage of the OrignalPrice that the CurrentPrice represents
long	EffectiveDateTimestamp	Timestamp indicating the effective date of the offer.
static final int	EOS_ECOM_CATALOGOFFER_API_LATEST	The most recent version of the EOS_Ecom_CatalogOffer struct.
static final int	EOS_ECOM_CATALOGOFFER_EFFECTIVEDATETIMESTAMP_UNDEFINED	Timestamp value representing an undefined EffectiveDateTimestamp for EOS_Ecom_CatalogOffer
static final int	EOS_ECOM_CATALOGOFFER_EXPIRATIONTIMESTAMP_UNDEFINED	Timestamp value representing an undefined ExpirationTimestamp for EOS_Ecom_CatalogOffer
static final int	EOS_ECOM_CATALOGOFFER_RELEASEDATETIMESTAMP_UNDEFINED	Timestamp value representing an undefined ReleaseDateTimestamp for EOS_Ecom_CatalogOffer
long	ExpirationTimestamp	Contains the POSIX timestamp that the offer expires or -1 if it does not expire
String	Id	The ID of this offer
EOS_Bool	IsAvailableForPurchase	True if the user can purchase this offer.
String	LongDescriptionText	Localized UTF-8 long description of this offer
int	OriginalPrice_DEPRECATED	The original price of this offer as a 32-bit number is deprecated.
long	OriginalPrice64	The original price of this offer as a 64-bit number.
EOS_EResult	PriceResult	If this value is EOS_Success then OriginalPrice, CurrentPrice, and DiscountPercentage contain valid data.
int	PurchasedCount_DEPRECATED	The number of times that the requesting account has purchased this offer.
int	PurchaseLimit	The maximum number of times that the offer can be purchased.
long	ReleaseDateTimestamp	Timestamp indicating when the time when the offer was released.
int	ServerIndex	The index of this offer as it exists on the server.
String	TechnicalDetailsText_DEPRECATED	Deprecated.
String	TitleText	Localized UTF-8 title of this offer

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor	Description
EOS_Ecom_CatalogOffer()
EOS_Ecom_CatalogOffer(com.sun.jna.Pointer peer)

Method Summary

Modifier and Type	Method	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 Details

EOS_ECOM_CATALOGOFFER_API_LATEST

public static final int EOS_ECOM_CATALOGOFFER_API_LATEST

The most recent version of the EOS_Ecom_CatalogOffer struct.

See Also:

• Constant Field Values

EOS_ECOM_CATALOGOFFER_EXPIRATIONTIMESTAMP_UNDEFINED

public static final int EOS_ECOM_CATALOGOFFER_EXPIRATIONTIMESTAMP_UNDEFINED

Timestamp value representing an undefined ExpirationTimestamp for EOS_Ecom_CatalogOffer

See Also:

• Constant Field Values

EOS_ECOM_CATALOGOFFER_RELEASEDATETIMESTAMP_UNDEFINED

public static final int EOS_ECOM_CATALOGOFFER_RELEASEDATETIMESTAMP_UNDEFINED

Timestamp value representing an undefined ReleaseDateTimestamp for EOS_Ecom_CatalogOffer

See Also:

• Constant Field Values

EOS_ECOM_CATALOGOFFER_EFFECTIVEDATETIMESTAMP_UNDEFINED

public static final int EOS_ECOM_CATALOGOFFER_EFFECTIVEDATETIMESTAMP_UNDEFINED

Timestamp value representing an undefined EffectiveDateTimestamp for EOS_Ecom_CatalogOffer

See Also:

• Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_ECOM_CATALOGOFFER_API_LATEST.

ServerIndex

public int ServerIndex

The index of this offer as it exists on the server. This is useful for understanding pagination data.

CatalogNamespace

public String CatalogNamespace

Product namespace in which this offer exists

Id

public String Id

The ID of this offer

TitleText

public String TitleText

Localized UTF-8 title of this offer

DescriptionText

public String DescriptionText

Localized UTF-8 description of this offer

LongDescriptionText

public String LongDescriptionText

Localized UTF-8 long description of this offer

TechnicalDetailsText_DEPRECATED

public String TechnicalDetailsText_DEPRECATED

Deprecated. EOS_Ecom_CatalogItem::TechnicalDetailsText is still valid.

CurrencyCode

public String CurrencyCode

The Currency Code for this offer

PriceResult

public EOS_EResult PriceResult

If this value is EOS_Success then OriginalPrice, CurrentPrice, and DiscountPercentage contain valid data. Otherwise this value represents the error that occurred on the price query.

OriginalPrice_DEPRECATED

public int OriginalPrice_DEPRECATED

The original price of this offer as a 32-bit number is deprecated.

CurrentPrice_DEPRECATED

public int CurrentPrice_DEPRECATED

The current price including discounts of this offer as a 32-bit number is deprecated..

DiscountPercentage

public byte DiscountPercentage

A value from 0 to 100 define the percentage of the OrignalPrice that the CurrentPrice represents

ExpirationTimestamp

public long ExpirationTimestamp

Contains the POSIX timestamp that the offer expires or -1 if it does not expire

PurchasedCount_DEPRECATED

public int PurchasedCount_DEPRECATED

The number of times that the requesting account has purchased this offer. This value is deprecated and the backend no longer returns this value.

PurchaseLimit

public int PurchaseLimit

The maximum number of times that the offer can be purchased. A negative value implies there is no limit.

IsAvailableForPurchase

public EOS_Bool IsAvailableForPurchase

True if the user can purchase this offer.

OriginalPrice64

public long OriginalPrice64

The original price of this offer as a 64-bit number.

CurrentPrice64

public long CurrentPrice64

The current price including discounts of this offer as a 64-bit number.

DecimalPoint

public int DecimalPoint

The decimal point for the provided price. For example, DecimalPoint '2' and CurrentPrice64 '12345' would be '123.45'.

ReleaseDateTimestamp

public long ReleaseDateTimestamp

Timestamp indicating when the time when the offer was released. Can be ignored if set to -1.

EffectiveDateTimestamp

public long EffectiveDateTimestamp

Timestamp indicating the effective date of the offer. Can be ignored if set to -1.

Constructor Details

EOS_Ecom_CatalogOffer

public EOS_Ecom_CatalogOffer()

EOS_Ecom_CatalogOffer

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

Method Details

release

public void release()

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception