Package host.anzo.eossdk.eos.sdk.connect

Class EOS_Connect_UserLoginInfo

java.lang.Object
com.sun.jna.Structure
host.anzo.eossdk.eos.sdk.connect.EOS_Connect_UserLoginInfo
Direct Known Subclasses:
EOS_Connect_UserLoginInfo.ByReference, EOS_Connect_UserLoginInfo.ByValue
@FieldOrder({"ApiVersion","DisplayName","NsaIdToken"}) public class EOS_Connect_UserLoginInfo extends com.sun.jna.Structure
Additional information about the local user.
Since:
8/5/2023

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    EOS_Connect_UserLoginInfo.ByReference
     
    static class 
    EOS_Connect_UserLoginInfo.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_CONNECT_USERLOGININFO_API_LATEST.
    String
    DisplayName
    The user's display name on the identity provider systems as UTF-8 encoded null-terminated string.
    static int
    EOS_CONNECT_USERLOGININFO_API_LATEST
    The most recent version of the EOS_Connect_UserLoginInfo struct.
    static int
    EOS_CONNECT_USERLOGININFO_DISPLAYNAME_MAX_LENGTH
    Max length of a display name, not including the terminating null.
    String
    NsaIdToken
    Nintendo Service Account ID Token (NSA ID).

    Fields inherited from class com.sun.jna.Structure

    ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

  • Constructor Summary

    Constructors
    Constructor
    Description
    EOS_Connect_UserLoginInfo()
     
    EOS_Connect_UserLoginInfo(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_CONNECT_USERLOGININFO_DISPLAYNAME_MAX_LENGTH

      public static int EOS_CONNECT_USERLOGININFO_DISPLAYNAME_MAX_LENGTH
      Max length of a display name, not including the terminating null.

    • EOS_CONNECT_USERLOGININFO_API_LATEST

      public static int EOS_CONNECT_USERLOGININFO_API_LATEST
      The most recent version of the EOS_Connect_UserLoginInfo struct.

    • ApiVersion

      public int ApiVersion
      API Version: Set this to EOS_CONNECT_USERLOGININFO_API_LATEST.

    • DisplayName

      public String DisplayName
      The user's display name on the identity provider systems as UTF-8 encoded null-terminated string. The length of the name can be at maximum up to EOS_CONNECT_USERLOGININFO_DISPLAYNAME_MAX_LENGTH bytes.

      As the display name passed here is client-controlled and not part of user authentication tokens, it is only treated as non-authoritative informational data to be used by some of the feature services. For example displaying player names in Leaderboards rankings.

    • NsaIdToken

      public String NsaIdToken
      Nintendo Service Account ID Token (NSA ID).

      This field is required to be set and only used when running on the Nintendo Switch device, and the user is being authenticated using any other credential type than EOS_ECT_NINTENDO_NSA_ID_TOKEN.

      In order to use the Lobbies and Sessions interfaces, a valid NSA ID Token is required to be provided for the active local Nintendo Switch user. Otherwise, attempting to use either of the Lobbies or Sessions interfaces will return the EOS_Permission_OnlinePlayRestricted error result.

  • Constructor Details

    • EOS_Connect_UserLoginInfo

      public EOS_Connect_UserLoginInfo()

    • EOS_Connect_UserLoginInfo

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