host.anzo.eossdk.eos.sdk.auth

Class EOS_Auth_IdToken

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.auth.EOS_Auth_IdToken

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

EOS_Auth_IdToken.ByReference, EOS_Auth_IdToken.ByValue

@Structure.FieldOrder(value={"ApiVersion","AccountId","JsonWebToken"})
public class EOS_Auth_IdToken
extends com.sun.jna.Structure
implements java.lang.AutoCloseable

A structure that contains an ID token. These structures are created by EOS_Auth_CopyIdToken and must be passed to EOS_Auth_IdToken_Release when finished.

Since:

8/5/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_Auth_IdToken.ByReference
static class	EOS_Auth_IdToken.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 and Description
EOS_EpicAccountId	AccountId The Epic Account ID described by the ID token.
int	ApiVersion API Version: Set this to EOS_AUTH_COPYUSERAUTHTOKEN_API_LATEST.
static int	EOS_AUTH_IDTOKEN_API_LATEST The most recent version of the EOS_Auth_IdToken struct.
java.lang.String	JsonWebToken The ID token as a Json Web Token (JWT) string.

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor and Description
EOS_Auth_IdToken()
EOS_Auth_IdToken(com.sun.jna.Pointer peer)

Method Summary

Modifier and Type	Method and Description
void	close()
void	release() Release the memory associated with an EOS_Auth_IdToken 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 Detail

EOS_AUTH_IDTOKEN_API_LATEST

public static int EOS_AUTH_IDTOKEN_API_LATEST

The most recent version of the EOS_Auth_IdToken struct.

ApiVersion

public int ApiVersion

API Version: Set this to EOS_AUTH_COPYUSERAUTHTOKEN_API_LATEST.

AccountId

public EOS_EpicAccountId AccountId

The Epic Account ID described by the ID token. Use EOS_EpicAccountId_FromString to populate this field when validating a received ID token.

JsonWebToken

public java.lang.String JsonWebToken

The ID token as a Json Web Token (JWT) string.

Constructor Detail

EOS_Auth_IdToken

public EOS_Auth_IdToken()

EOS_Auth_IdToken

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

Method Detail

release

public void release()

Release the memory associated with an EOS_Auth_IdToken structure. This must be called on data retrieved from EOS_Auth_CopyIdToken.

See Also:

EOS_Auth_IdToken, EOS_Auth_Interface.copyIdToken(EOS_EpicAccountId)

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception