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

Class EOS_Auth_Token

java.lang.Object
com.sun.jna.Structure
host.anzo.eossdk.eos.sdk.auth.EOS_Auth_Token
All Implemented Interfaces:
AutoCloseable
Direct Known Subclasses:
EOS_Auth_Token.ByReference, EOS_Auth_Token.ByValue
@FieldOrder({"ApiVersion","App","ClientId","AccountId","AccessToken","ExpiresIn","ExpiresAt","AuthType","RefreshToken","RefreshExpiresIn","RefreshExpiresAt"}) public class EOS_Auth_Token extends com.sun.jna.Structure implements AutoCloseable
A structure that contains an auth token. These structures are created by EOS_Auth_CopyUserAuthToken and must be passed to EOS_Auth_Token_Release.
Since:
8/5/2023

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    EOS_Auth_Token.ByReference
     
    static class 
    EOS_Auth_Token.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
    String
    AccessToken
    Access token for the current user login session
    EOS_EpicAccountId
    AccountId
    The Epic Account ID associated with this auth token
    int
    ApiVersion
    API Version: Set this to EOS_ANTICHEATCOMMON_LOGPLAYERTICK_API_LATEST.
    EOS_EAuthTokenType
    AuthType
    Type of auth token
    String
    ClientId
    Client ID that requested this token
    static int
    EOS_AUTH_TOKEN_API_LATEST
    The most recent version of the EOS_Auth_Token struct.
    String
    ExpiresAt
    Absolute time in UTC before the access token expires, in ISO 8601 format
    double
    ExpiresIn
    Time before the access token expires, in seconds, relative to the call to EOS_Auth_CopyUserAuthToken
    String
    RefreshExpiresAt
    Absolute time in UTC before the refresh token expires, in ISO 8601 format
    double
    RefreshExpiresIn
    Time before the access token expires, in seconds, relative to the call to EOS_Auth_CopyUserAuthToken
    String
    RefreshToken
    Refresh token.

    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_Token()
     
    EOS_Auth_Token(com.sun.jna.Pointer peer)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
     
    void
    release()
    Release the memory associated with an EOS_Auth_Token structure.

    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_TOKEN_API_LATEST

      public static int EOS_AUTH_TOKEN_API_LATEST
      The most recent version of the EOS_Auth_Token struct.

    • ApiVersion

      public int ApiVersion
      API Version: Set this to EOS_ANTICHEATCOMMON_LOGPLAYERTICK_API_LATEST.

    • ClientId

      public String ClientId
      Client ID that requested this token

    • AccountId

      public EOS_EpicAccountId AccountId
      The Epic Account ID associated with this auth token

    • AccessToken

      public String AccessToken
      Access token for the current user login session

    • ExpiresIn

      public double ExpiresIn
      Time before the access token expires, in seconds, relative to the call to EOS_Auth_CopyUserAuthToken

    • ExpiresAt

      public String ExpiresAt
      Absolute time in UTC before the access token expires, in ISO 8601 format

    • AuthType

      public EOS_EAuthTokenType AuthType
      Type of auth token

    • RefreshToken

      public String RefreshToken
      Refresh token.
      See Also:

    • RefreshExpiresIn

      public double RefreshExpiresIn
      Time before the access token expires, in seconds, relative to the call to EOS_Auth_CopyUserAuthToken

    • RefreshExpiresAt

      public String RefreshExpiresAt
      Absolute time in UTC before the refresh token expires, in ISO 8601 format

  • Constructor Details

    • EOS_Auth_Token

      public EOS_Auth_Token()

    • EOS_Auth_Token

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

  • Method Details