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

Class EOS_Auth_LinkAccountOptions

java.lang.Object
com.sun.jna.Structure
host.anzo.eossdk.eos.sdk.auth.options.EOS_Auth_LinkAccountOptions
Direct Known Subclasses:
EOS_Auth_LinkAccountOptions.ByReference, EOS_Auth_LinkAccountOptions.ByValue
@FieldOrder({"ApiVersion","LinkAccountFlags","ContinuanceToken","LocalUserId"}) public class EOS_Auth_LinkAccountOptions extends com.sun.jna.Structure
Input parameters for the EOS_Auth_LinkAccount function.
Since:
8/5/2023

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    EOS_Auth_LinkAccountOptions.ByReference
     
    static class 
    EOS_Auth_LinkAccountOptions.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_AUTH_LINKACCOUNT_API_LATEST.
    EOS_ContinuanceToken
    ContinuanceToken
    Continuance token received from a previous call to the EOS_Auth_Login API.
    static int
    EOS_AUTH_LINKACCOUNT_API_LATEST
    The most recent version of the EOS_Auth_LinkAccount API.
    EOS_ELinkAccountFlags
    LinkAccountFlags
    Combination of the enumeration flags to specify how the account linking operation will be performed.
    EOS_EpicAccountId
    LocalUserId
    The Epic Account ID of the logged in local user whose Epic Account will be linked with the local Nintendo NSA ID Account.

    Fields inherited from class com.sun.jna.Structure

    ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

  • Constructor Summary

    Constructors
    Constructor
    Description
    EOS_Auth_LinkAccountOptions()
     
    EOS_Auth_LinkAccountOptions(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_AUTH_LINKACCOUNT_API_LATEST

      public static int EOS_AUTH_LINKACCOUNT_API_LATEST
      The most recent version of the EOS_Auth_LinkAccount API.

    • ApiVersion

      public int ApiVersion
      API Version: Set this to EOS_AUTH_LINKACCOUNT_API_LATEST.

    • LinkAccountFlags

      public EOS_ELinkAccountFlags LinkAccountFlags
      Combination of the enumeration flags to specify how the account linking operation will be performed.
      See Also:

    • ContinuanceToken

      public EOS_ContinuanceToken ContinuanceToken
      Continuance token received from a previous call to the EOS_Auth_Login API.

      A continuance token is received in the case when the external account used for login was not found to be linked against any existing Epic Account. In such case, the application needs to proceed with an account linking operation in which case the user is first asked to create a new account or login into their existing Epic Account, and then link their external account to it. Alternatively, the application may suggest the user to login using another external account that they have already linked to their existing Epic Account. In this flow, the external account is typically the currently logged in local platform user account. It can also be another external user account that the user is offered to login with.

    • LocalUserId

      public EOS_EpicAccountId LocalUserId
      The Epic Account ID of the logged in local user whose Epic Account will be linked with the local Nintendo NSA ID Account. By default set to NULL.

      This parameter is only used and required to be set when EOS_ELinkAccountFlags::EOS_LA_NintendoNsaId is specified. Otherwise, set to NULL, as the standard account linking and login flow using continuance token will handle logging in the user to their Epic Account.

  • Constructor Details

    • EOS_Auth_LinkAccountOptions

      public EOS_Auth_LinkAccountOptions()

    • EOS_Auth_LinkAccountOptions

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