host.anzo.eossdk.eos.sdk.sessions.options

Class EOS_Sessions_CreateSessionModificationOptions

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.sessions.options.EOS_Sessions_CreateSessionModificationOptions

Direct Known Subclasses:

EOS_Sessions_CreateSessionModificationOptions.ByReference, EOS_Sessions_CreateSessionModificationOptions.ByValue

@Structure.FieldOrder(value={"ApiVersion","SessionName","BucketId","MaxPlayers","LocalUserId","IsPresenceEnabled","SessionId","IsSanctionsEnabled","AllowedPlatformIds","AllowedPlatformIdsCount"})
public class EOS_Sessions_CreateSessionModificationOptions
extends com.sun.jna.Structure

Input parameters for the EOS_Sessions_CreateSessionModification function.

Since:

9/5/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_Sessions_CreateSessionModificationOptions.ByReference
static class	EOS_Sessions_CreateSessionModificationOptions.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
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_SESSIONS_CREATESESSIONMODIFICATION_API_LATEST.
java.lang.String	BucketId Bucket ID associated with the session
static int	EOS_SESSIONS_CREATESESSIONMODIFICATION_API_LATEST The most recent version of the EOS_Sessions_CreateSessionModification API.
EOS_Bool	IsPresenceEnabled Determines whether or not this session should be the one associated with the local user's presence information.
EOS_Bool	IsSanctionsEnabled If true, sanctioned players can neither join nor register with this session and, in the case of join, will return EOS_EResult code EOS_Sessions_PlayerSanctioned
EOS_ProductUserId	LocalUserId The Product User ID of the local user associated with the session
int	MaxPlayers Maximum number of players allowed in the session
java.lang.String	SessionId Optional session id - set to a globally unique value to override the backend assignment If not specified the backend service will assign one to the session.
java.lang.String	SessionName Name of the session to create

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_Sessions_CreateSessionModificationOptions()
EOS_Sessions_CreateSessionModificationOptions(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_SESSIONS_CREATESESSIONMODIFICATION_API_LATEST

public static int EOS_SESSIONS_CREATESESSIONMODIFICATION_API_LATEST

The most recent version of the EOS_Sessions_CreateSessionModification API.

ApiVersion

public int ApiVersion

API Version: Set this to EOS_SESSIONS_CREATESESSIONMODIFICATION_API_LATEST.

SessionName

public java.lang.String SessionName

Name of the session to create

BucketId

public java.lang.String BucketId

Bucket ID associated with the session

MaxPlayers

public int MaxPlayers

Maximum number of players allowed in the session

LocalUserId

public EOS_ProductUserId LocalUserId

The Product User ID of the local user associated with the session

IsPresenceEnabled

public EOS_Bool IsPresenceEnabled

Determines whether or not this session should be the one associated with the local user's presence information. If true, this session will be associated with presence. Only one session at a time can have this flag true. This affects the ability of the Social Overlay to show game related actions to take in the user's social graph.
The Social Overlay can handle only one of the following three options at a time:

• using the bPresenceEnabled flags within the Sessions interface
• using the bPresenceEnabled flags within the Lobby interface
• using EOS_PresenceModification_SetJoinInfo

See Also:

EOS_PresenceModification_SetJoinInfoOptions, EOS_Lobby_CreateLobbyOptions, EOS_Lobby_JoinLobbyOptions, EOS_Sessions_JoinSessionOptions

SessionId

public java.lang.String SessionId

Optional session id - set to a globally unique value to override the backend assignment If not specified the backend service will assign one to the session. Do not mix and match. This value can be of size [EOS_Defines.EOS_SESSIONMODIFICATION_MIN_SESSIONIDOVERRIDE_LENGTH, EOS_Defines.EOS_SESSIONMODIFICATION_MAX_SESSIONIDOVERRIDE_LENGTH]

IsSanctionsEnabled

public EOS_Bool IsSanctionsEnabled

If true, sanctioned players can neither join nor register with this session and, in the case of join, will return EOS_EResult code EOS_Sessions_PlayerSanctioned

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 (eos_common.h), for example 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 Detail

EOS_Sessions_CreateSessionModificationOptions

public EOS_Sessions_CreateSessionModificationOptions()

EOS_Sessions_CreateSessionModificationOptions

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