host.anzo.eossdk.eos.sdk.metrics.options

Class EOS_Metrics_BeginPlayerSessionOptions

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.metrics.options.EOS_Metrics_BeginPlayerSessionOptions

Direct Known Subclasses:

EOS_Metrics_BeginPlayerSessionOptions.ByReference, EOS_Metrics_BeginPlayerSessionOptions.ByValue

@Structure.FieldOrder(value={"ApiVersion","AccountIdType","AccountId","DisplayName","ControllerType","ServerIp","GameSessionId"})
public class EOS_Metrics_BeginPlayerSessionOptions
extends com.sun.jna.Structure

BeginPlayerSession

Since:

8/21/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_Metrics_BeginPlayerSessionOptions.AccountId_union
static class	EOS_Metrics_BeginPlayerSessionOptions.ByReference
static class	EOS_Metrics_BeginPlayerSessionOptions.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
EOS_Metrics_BeginPlayerSessionOptions.AccountId_union	AccountId The Account ID for the player whose session is beginning.
EOS_EMetricsAccountIdType	AccountIdType The Account ID type that is set in the union.
int	ApiVersion API Version: Set this to EOS_METRICS_BEGINPLAYERSESSION_API_LATEST.
EOS_EUserControllerType	ControllerType The user's game controller type.
java.lang.String	DisplayName The in-game display name for the user as UTF-8 string.
static int	EOS_METRICS_BEGINPLAYERSESSION_API_LATEST The most recent version of the EOS_Metrics_BeginPlayerSessionOptions struct.
java.lang.String	GameSessionId Optional, application-defined custom match session identifier.
java.lang.String	ServerIp IP address of the game server hosting the game session.

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_Metrics_BeginPlayerSessionOptions()
EOS_Metrics_BeginPlayerSessionOptions(com.sun.jna.Pointer peer)

Method Summary

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_METRICS_BEGINPLAYERSESSION_API_LATEST

public static final int EOS_METRICS_BEGINPLAYERSESSION_API_LATEST

The most recent version of the EOS_Metrics_BeginPlayerSessionOptions struct.

See Also:

Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_METRICS_BEGINPLAYERSESSION_API_LATEST.

AccountIdType

public EOS_EMetricsAccountIdType AccountIdType

The Account ID type that is set in the union.

AccountId

public EOS_Metrics_BeginPlayerSessionOptions.AccountId_union AccountId

The Account ID for the player whose session is beginning.

DisplayName

public java.lang.String DisplayName

The in-game display name for the user as UTF-8 string.

ControllerType

public EOS_EUserControllerType ControllerType

The user's game controller type.

ServerIp

public java.lang.String ServerIp

IP address of the game server hosting the game session. For a localhost session, set to NULL.
Must be in either one of the following IPv4 or IPv6 string formats:

• "127.0.0.1".
• "1200:0000:AB00:1234:0000:2552:7777:1313".

If both IPv4 and IPv6 addresses are available, use the IPv6 address.

GameSessionId

public java.lang.String GameSessionId

Optional, application-defined custom match session identifier. If the identifier is not used, set to NULL.
The game can tag each game session with a custom session match identifier, which will be shown in the Played Sessions listing at the user profile dashboard.

Constructor Detail

EOS_Metrics_BeginPlayerSessionOptions

public EOS_Metrics_BeginPlayerSessionOptions()

EOS_Metrics_BeginPlayerSessionOptions

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