host.anzo.eossdk.eos.sdk.sessions.callbackresults

Class EOS_Sessions_RegisterPlayersCallbackInfo

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.sessions.callbackresults.EOS_Sessions_RegisterPlayersCallbackInfo

Direct Known Subclasses:

EOS_Sessions_RegisterPlayersCallbackInfo.ByReference, EOS_Sessions_RegisterPlayersCallbackInfo.ByValue

@Structure.FieldOrder(value={"ResultCode","ClientData","RegisteredPlayers","RegisteredPlayersCount","SanctionedPlayers","SanctionedPlayersCount"})
public class EOS_Sessions_RegisterPlayersCallbackInfo
extends com.sun.jna.Structure

Output parameters for the EOSLibrary.EOS_Sessions_RegisterPlayers(host.anzo.eossdk.eos.sdk.EOS_Sessions_Interface, host.anzo.eossdk.eos.sdk.sessions.options.EOS_Sessions_RegisterPlayersOptions, com.sun.jna.Pointer, host.anzo.eossdk.eos.sdk.sessions.callbacks.EOS_Sessions_OnRegisterPlayersCallback) function.

Since:

9/7/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_Sessions_RegisterPlayersCallbackInfo.ByReference
static class	EOS_Sessions_RegisterPlayersCallbackInfo.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.Pointer	ClientData Context that was passed into EOS_Sessions_RegisterPlayers
com.sun.jna.Pointer	RegisteredPlayers The players that were successfully registered
int	RegisteredPlayersCount The number of players successfully registered
EOS_EResult	ResultCode The EOS_EResult code for the operation.
com.sun.jna.Pointer	SanctionedPlayers The players that failed to register because they are sanctioned
int	SanctionedPlayersCount The number of players that failed to register because they are sanctioned

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

Method Summary

Modifier and Type	Method and Description
java.util.List<EOS_ProductUserId>	getRegisteredPlayers()
java.util.List<EOS_ProductUserId>	getSanctionedPlayers()

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

ResultCode

public EOS_EResult ResultCode

The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors.
EOS_EResult.EOS_Success if the register completes successfully
EOS_EResult.EOS_NoChange if the players to register registered previously
EOS_EResult.EOS_InvalidParameters if any of the options are incorrect
EOS_EResult.EOS_Sessions_OutOfSync if the session is out of sync and will be updated on the next connection with the backend
EOS_EResult.EOS_NotFound if a session to register players does not exist
EOS_EResult.EOS_LimitExceeded if registering the requested players would drive the total number of registered players beyond EOS_SESSIONS_MAXREGISTEREDPLAYERS (API Version <= 2)
EOS_EResult.EOS_Sessions_TooManyPlayers if registering the requested players would drive the total number of registered players beyond EOS_SESSIONS_MAXREGISTEREDPLAYERS (API Version > 2)

ClientData

public com.sun.jna.Pointer ClientData

Context that was passed into EOS_Sessions_RegisterPlayers

RegisteredPlayers

public com.sun.jna.Pointer RegisteredPlayers

The players that were successfully registered

RegisteredPlayersCount

public int RegisteredPlayersCount

The number of players successfully registered

SanctionedPlayers

public com.sun.jna.Pointer SanctionedPlayers

The players that failed to register because they are sanctioned

SanctionedPlayersCount

public int SanctionedPlayersCount

The number of players that failed to register because they are sanctioned

Constructor Detail

EOS_Sessions_RegisterPlayersCallbackInfo

public EOS_Sessions_RegisterPlayersCallbackInfo()

EOS_Sessions_RegisterPlayersCallbackInfo

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

Method Detail

getRegisteredPlayers

public java.util.List<EOS_ProductUserId> getRegisteredPlayers()

Returns:

list of registered players

getSanctionedPlayers

public java.util.List<EOS_ProductUserId> getSanctionedPlayers()

Returns:

list of sanctioned players