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:

java.lang.AutoCloseable

Direct Known Subclasses:

EOS_Presence_Info.ByReference, EOS_Presence_Info.ByValue

@Structure.FieldOrder(value={"ApiVersion","Status","UserId","ProductId","ProductVersion","Platform","RichText","RecordsCount","Records","ProductName","IntegratedPlatform"})
public class EOS_Presence_Info
extends com.sun.jna.Structure
implements java.lang.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 and 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 and Description
int	ApiVersion API Version: Set this to EOS_PRESENCE_INFO_API_LATEST.
static int	EOS_PRESENCE_INFO_API_LATEST The most recent version of the EOS_Presence_Info API.
java.lang.String	IntegratedPlatform The integrated platform that the user is logged in with
java.lang.String	Platform The platform of that the user is logged in from
java.lang.String	ProductId The product ID that the user is logged in from
java.lang.String	ProductName The user-facing name for the product the user is logged in from
java.lang.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
java.lang.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 and Description
EOS_Presence_Info()
EOS_Presence_Info(com.sun.jna.Pointer peer)

Method Summary

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

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 java.lang.String ProductId

The product ID that the user is logged in from

ProductVersion

public java.lang.String ProductVersion

The version of the product the user is logged in from

Platform

public java.lang.String Platform

The platform of that the user is logged in from

RichText

public java.lang.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 java.lang.String ProductName

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

IntegratedPlatform

public java.lang.String IntegratedPlatform

The integrated platform that the user is logged in with

Constructor Detail

EOS_Presence_Info

public EOS_Presence_Info()

EOS_Presence_Info

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

Method Detail

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 java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception