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

Class EOS_Auth_LoginOptions

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    EOS_Auth_LoginOptions.ByReference
     
    static class 
    EOS_Auth_LoginOptions.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_LOGIN_API_LATEST.
    EOS_Auth_Credentials.ByReference
    Credentials
    Credentials specified for a given login method
    static int
    EOS_AUTH_LOGIN_API_LATEST
    The most recent version of the EOS_Auth_Login API.
    static long
    EOS_LF_NO_USER_INTERFACE
    Specify login to be performed without SDK provided user interface.
    com.sun.jna.NativeLong
    LoginFlags
    Optional flags for the desired login behavior, e.g.
    EOS_EAuthScopeFlags
    ScopeFlags
    Auth scope flags are permissions to request from the user while they are logging in.

    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_LoginOptions()
     
    EOS_Auth_LoginOptions(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_LF_NO_USER_INTERFACE

      public static long EOS_LF_NO_USER_INTERFACE
      Specify login to be performed without SDK provided user interface. By default, and without this flag, the SDK uses the overlay or a system browser to show user interfaces during login when the user needs to perform some action. With this flag, an error such as EOS_Auth_UserInterfaceRequired is returned to the login callback, and no user interface is shown in those cases.

    • EOS_AUTH_LOGIN_API_LATEST

      public static int EOS_AUTH_LOGIN_API_LATEST
      The most recent version of the EOS_Auth_Login API.

    • ApiVersion

      public int ApiVersion
      API Version: Set this to EOS_AUTH_LOGIN_API_LATEST.

    • Credentials

      public EOS_Auth_Credentials.ByReference Credentials
      Credentials specified for a given login method

    • ScopeFlags

      public EOS_EAuthScopeFlags ScopeFlags
      Auth scope flags are permissions to request from the user while they are logging in. This is a bitwise-or union of EOS_EAuthScopeFlags flags defined above

    • LoginFlags

      public com.sun.jna.NativeLong LoginFlags
      Optional flags for the desired login behavior, e.g. EOS_LF_NO_USER_INTERFACE. This is a bitwise-or union of the defined flags.

  • Constructor Details

    • EOS_Auth_LoginOptions

      public EOS_Auth_LoginOptions()

    • EOS_Auth_LoginOptions

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