Package host.anzo.eossdk.eos.sdk.presence

Class EOS_Presence_Info

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.presence.EOS_Presence_Info

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

EOS_Presence_Info.ByReference, EOS_Presence_Info.ByValue

@FieldOrder({"ApiVersion","Status","UserId","ProductId","ProductVersion","Platform","RichText","RecordsCount","Records","ProductName","IntegratedPlatform"})
public class EOS_Presence_Info
extends com.sun.jna.Structure
implements AutoCloseable

All the known presence information for a specific user. This object must be released by calling EOS_Presence_Info_Release.

Since:

8/22/2023

See Also:

• EOS_Presence_Interface.copyPresence(EOS_Presence_CopyPresenceOptions)
• release()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EOS_Presence_Info.ByReference
static class	EOS_Presence_Info.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_PRESENCE_INFO_API_LATEST.
static final int	EOS_PRESENCE_INFO_API_LATEST	The most recent version of the EOS_Presence_Info API.
String	IntegratedPlatform	The integrated platform that the user is logged in with
String	Platform	The platform of that the user is logged in from
String	ProductId	The product ID that the user is logged in from
String	ProductName	The user-facing name for the product the user is logged in from
String	ProductVersion	The version of the product the user is logged in from
EOS_Presence_DataRecord.ByReference	Records	The first data record, or NULL if RecordsCount is not at least 1
int	RecordsCount	The count of records available
String	RichText	The rich-text of the user
EOS_Presence_EStatus	Status	The status of the user
EOS_EpicAccountId	UserId	The Epic Account ID of the user

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	close()
void	release()	Release the memory associated with an EOS_Presence_Info structure and its sub-objects.

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_PRESENCE_INFO_API_LATEST

public static final int EOS_PRESENCE_INFO_API_LATEST

The most recent version of the EOS_Presence_Info API.

See Also:

• Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_PRESENCE_INFO_API_LATEST.

Status

public EOS_Presence_EStatus Status

The status of the user

UserId

public EOS_EpicAccountId UserId

The Epic Account ID of the user

ProductId

public String ProductId

The product ID that the user is logged in from

ProductVersion

public String ProductVersion

The version of the product the user is logged in from

Platform

public String Platform

The platform of that the user is logged in from

RichText

public String RichText

The rich-text of the user

RecordsCount

public int RecordsCount

The count of records available

Records

public EOS_Presence_DataRecord.ByReference Records

The first data record, or NULL if RecordsCount is not at least 1

ProductName

public String ProductName

The user-facing name for the product the user is logged in from

IntegratedPlatform

public String IntegratedPlatform

The integrated platform that the user is logged in with

Constructor Details

EOS_Presence_Info

public EOS_Presence_Info()

EOS_Presence_Info

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

Method Details

release

public void release()

Release the memory associated with an EOS_Presence_Info structure and its sub-objects. This must be called on data retrieved from EOS_Presence_CopyPresence. This can be safely called on a NULL presence info object.

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception