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

Class EOS_Sessions_JoinSessionOptions

java.lang.Object
com.sun.jna.Structure
host.anzo.eossdk.eos.sdk.sessions.options.EOS_Sessions_JoinSessionOptions
Direct Known Subclasses:
EOS_Sessions_JoinSessionOptions.ByReference, EOS_Sessions_JoinSessionOptions.ByValue
@FieldOrder({"ApiVersion","SessionName","SessionHandle","LocalUserId","IsPresenceEnabled"}) public class EOS_Sessions_JoinSessionOptions extends com.sun.jna.Structure
Input parameters for the EOS_Sessions_JoinSession function.
Since:
9/7/2023

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    EOS_Sessions_JoinSessionOptions.ByReference
     
    static class 
    EOS_Sessions_JoinSessionOptions.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
    int
    ApiVersion
    API Version: Set this to EOS_SESSIONS_JOINSESSION_API_LATEST.
    static final int
    EOS_SESSIONS_JOINSESSION_API_LATEST
     
    EOS_Bool
    IsPresenceEnabled
    Determines whether or not this session should be the one associated with the local user's presence information.
    EOS_ProductUserId
    LocalUserId
    The Product User ID of the local user who is joining the session
    EOS_SessionDetails
    SessionHandle
    Session handle to join
    String
    SessionName
    Name of the session to create after joining 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_Sessions_JoinSessionOptions()
     
    EOS_Sessions_JoinSessionOptions(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_SESSIONS_JOINSESSION_API_LATEST

      public static final int EOS_SESSIONS_JOINSESSION_API_LATEST
      See Also:

    • ApiVersion

      public int ApiVersion
      API Version: Set this to EOS_SESSIONS_JOINSESSION_API_LATEST.

    • SessionName

      public String SessionName
      Name of the session to create after joining session

    • SessionHandle

      public EOS_SessionDetails SessionHandle
      Session handle to join

    • LocalUserId

      public EOS_ProductUserId LocalUserId
      The Product User ID of the local user who is joining 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:

  • Constructor Details

    • EOS_Sessions_JoinSessionOptions

      public EOS_Sessions_JoinSessionOptions()

    • EOS_Sessions_JoinSessionOptions

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