Package host.anzo.eossdk.eos.sdk.sessions

Class EOS_SessionDetails_Settings

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.sessions.EOS_SessionDetails_Settings

Direct Known Subclasses:

EOS_SessionDetails_Settings.ByReference, EOS_SessionDetails_Settings.ByValue

@FieldOrder({"ApiVersion","BucketId","NumPublicConnections","IsAllowJoinInProgress","PermissionLevel","IsInvitesAllowed","IsSanctionsEnabled","AllowedPlatformIds","AllowedPlatformIdsCount"})
public class EOS_SessionDetails_Settings
extends com.sun.jna.Structure

Top level details about an active session

Since:

9/5/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EOS_SessionDetails_Settings.ByReference
static class	EOS_SessionDetails_Settings.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
com.sun.jna.ptr.IntByReference	AllowedPlatformIds	Array of platform IDs indicating the player platforms allowed to register with the session.
int	AllowedPlatformIdsCount	Number of platform IDs in the array
int	ApiVersion	API Version: Set this to EOS_SESSIONDETAILS_SETTINGS_API_LATEST.
String	BucketId	The main indexed parameter for this session, can be any string (i.e.
static final int	EOS_SESSIONDETAILS_SETTINGS_API_LATEST	The most recent version of the EOS_SessionDetails_Settings struct.
EOS_Bool	IsAllowJoinInProgress	Are players allowed to join the session while it is in the "in progress" state
EOS_Bool	IsInvitesAllowed	Are players allowed to send invites for the session
EOS_Bool	IsSanctionsEnabled	Are sanctioned players allowed to join - sanctioned players will be rejected if set to true
int	NumPublicConnections	Number of total players allowed in the session
EOS_EOnlineSessionPermissionLevel	PermissionLevel	Permission level describing allowed access to the session when joining or searching for the session

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor	Description
EOS_SessionDetails_Settings()
EOS_SessionDetails_Settings(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 Details

EOS_SESSIONDETAILS_SETTINGS_API_LATEST

public static final int EOS_SESSIONDETAILS_SETTINGS_API_LATEST

The most recent version of the EOS_SessionDetails_Settings struct.

See Also:

• Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_SESSIONDETAILS_SETTINGS_API_LATEST.

BucketId

public String BucketId

The main indexed parameter for this session, can be any string (i.e. "Region:GameMode")

NumPublicConnections

public int NumPublicConnections

Number of total players allowed in the session

IsAllowJoinInProgress

public EOS_Bool IsAllowJoinInProgress

Are players allowed to join the session while it is in the "in progress" state

PermissionLevel

public EOS_EOnlineSessionPermissionLevel PermissionLevel

Permission level describing allowed access to the session when joining or searching for the session

IsInvitesAllowed

public EOS_Bool IsInvitesAllowed

Are players allowed to send invites for the session

IsSanctionsEnabled

public EOS_Bool IsSanctionsEnabled

Are sanctioned players allowed to join - sanctioned players will be rejected if set to true

AllowedPlatformIds

public com.sun.jna.ptr.IntByReference AllowedPlatformIds

Array of platform IDs indicating the player platforms allowed to register with the session. Platform IDs are found in the EOS header file, e.g. EOS_OPT_Epic. For some platforms, the value will be in the EOS Platform specific header file. If null, the session will be unrestricted.

AllowedPlatformIdsCount

public int AllowedPlatformIdsCount

Number of platform IDs in the array

Constructor Details

EOS_SessionDetails_Settings

public EOS_SessionDetails_Settings()

EOS_SessionDetails_Settings

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