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

Class EOS_Sessions_UnregisterPlayersCallbackInfo

java.lang.Object

com.sun.jna.Structure

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

Direct Known Subclasses:

EOS_Sessions_UnregisterPlayersCallbackInfo.ByReference, EOS_Sessions_UnregisterPlayersCallbackInfo.ByValue

@Structure.FieldOrder(value={"ResultCode","ClientData","UnregisteredPlayers","UnregisteredPlayersCount"})
public class EOS_Sessions_UnregisterPlayersCallbackInfo
extends com.sun.jna.Structure

Output parameters for the EOSLibrary.EOS_Sessions_UnregisterPlayers(host.anzo.eossdk.eos.sdk.EOS_Sessions_Interface, host.anzo.eossdk.eos.sdk.sessions.options.EOS_Sessions_UnregisterPlayersOptions, com.sun.jna.Pointer, host.anzo.eossdk.eos.sdk.sessions.callbacks.EOS_Sessions_OnUnregisterPlayersCallback) function.

Since:

9/7/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_Sessions_UnregisterPlayersCallbackInfo.ByReference
static class	EOS_Sessions_UnregisterPlayersCallbackInfo.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_UnregisterPlayers
EOS_EResult	ResultCode The EOS_EResult code for the operation.
com.sun.jna.Pointer	UnregisteredPlayers The players that successfully unregistered
int	UnregisteredPlayersCount The number of players that successfully unregistered

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

Method Summary

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

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 unregister completes successfully
EOS_EResult.EOS_NoChange if the players to unregister were not found
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 backendv EOS_EResult.EOS_NotFound if a session to be unregister players does not exist

ClientData

public com.sun.jna.Pointer ClientData

Context that was passed into EOS_Sessions_UnregisterPlayers

UnregisteredPlayers

public com.sun.jna.Pointer UnregisteredPlayers

The players that successfully unregistered

UnregisteredPlayersCount

public int UnregisteredPlayersCount

The number of players that successfully unregistered

Constructor Detail

EOS_Sessions_UnregisterPlayersCallbackInfo

public EOS_Sessions_UnregisterPlayersCallbackInfo()

EOS_Sessions_UnregisterPlayersCallbackInfo

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

Method Detail

getUnregisteredPlayers

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

Returns:

list of unregistered players