host.anzo.eossdk.eos.sdk.ecom

Class EOS_Ecom_KeyImageInfo

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.ecom.EOS_Ecom_KeyImageInfo

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

EOS_Ecom_KeyImageInfo.ByReference, EOS_Ecom_KeyImageInfo.ByValue

@Structure.FieldOrder(value={"ApiVersion","Type","Url","Width","Height"})
public class EOS_Ecom_KeyImageInfo
extends com.sun.jna.Structure
implements java.lang.AutoCloseable

Contains information about a key image used by the catalog. Instances of this structure are created by EOS_Ecom_CopyItemImageInfoByIndex. They must be passed to release(). A Key Image is defined within Dev Portal and is associated with a Catalog Item. A Key Image is intended to be used to provide imagery for an in-game store.

Since:

8/20/2023

See Also:

EOS_Ecom_Interface.copyItemImageInfoByIndex(EOS_Ecom_CopyItemImageInfoByIndexOptions), release()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_Ecom_KeyImageInfo.ByReference
static class	EOS_Ecom_KeyImageInfo.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_KEYIMAGEINFO_API_LATEST.
static int	EOS_ECOM_KEYIMAGEINFO_API_LATEST The most recent version of the EOS_Ecom_KeyImageInfo struct.
int	Height The expected height in pixels of the image
java.lang.String	Type Describes the usage of the image (ex: home_thumbnail)
java.lang.String	Url The URL of the image
int	Width The expected width in pixels of the image

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_KeyImageInfo()
EOS_Ecom_KeyImageInfo(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_KEYIMAGEINFO_API_LATEST

public static final int EOS_ECOM_KEYIMAGEINFO_API_LATEST

The most recent version of the EOS_Ecom_KeyImageInfo struct.

See Also:

Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_ECOM_KEYIMAGEINFO_API_LATEST.

Type

public java.lang.String Type

Describes the usage of the image (ex: home_thumbnail)

Url

public java.lang.String Url

The URL of the image

Width

public int Width

The expected width in pixels of the image

Height

public int Height

The expected height in pixels of the image

Constructor Detail

EOS_Ecom_KeyImageInfo

public EOS_Ecom_KeyImageInfo()

EOS_Ecom_KeyImageInfo

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