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

@FieldOrder({"ResultCode","ClientData","RegisteredPlayers","RegisteredPlayersCount","SanctionedPlayers","SanctionedPlayersCount"}) public class EOS_Sessions_RegisterPlayersCallbackInfo extends com.sun.jna.Structure
Since:
9/7/2023
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
     
    static class 
     

    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.Pointer
    Context that was passed into EOS_Sessions_RegisterPlayers
    The players that were successfully registered
    int
    The number of players successfully registered
    The EOS_EResult code for the operation.
    The players that failed to register because they are sanctioned
    int
    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
    Description
     
    EOS_Sessions_RegisterPlayersCallbackInfo(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

    • 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 EOS_ProductUserId RegisteredPlayers
      The players that were successfully registered
    • RegisteredPlayersCount

      public int RegisteredPlayersCount
      The number of players successfully registered
    • SanctionedPlayers

      public EOS_ProductUserId 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 Details

    • EOS_Sessions_RegisterPlayersCallbackInfo

      public EOS_Sessions_RegisterPlayersCallbackInfo()
    • EOS_Sessions_RegisterPlayersCallbackInfo

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