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

Class EOS_Auth_QueryIdTokenOptions

java.lang.Object

com.sun.jna.Structure

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

Direct Known Subclasses:

EOS_Auth_QueryIdTokenOptions.ByReference, EOS_Auth_QueryIdTokenOptions.ByValue

@FieldOrder({"ApiVersion","LocalUserId","TargetAccountId"})
public class EOS_Auth_QueryIdTokenOptions
extends com.sun.jna.Structure

Input parameters for the EOS_Auth_QueryIdToken function.

Since:

8/5/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EOS_Auth_QueryIdTokenOptions.ByReference
static class	EOS_Auth_QueryIdTokenOptions.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_QUERYIDTOKEN_API_LATEST.
static int	EOS_AUTH_QUERYIDTOKEN_API_LATEST	The most recent version of the EOS_Auth_QueryIdToken API.
EOS_EpicAccountId	LocalUserId	The Epic Account ID of the local authenticated user.
EOS_EpicAccountId	TargetAccountId	The target Epic Account ID for which to query an ID 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_QueryIdTokenOptions()
EOS_Auth_QueryIdTokenOptions(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_QUERYIDTOKEN_API_LATEST

public static int EOS_AUTH_QUERYIDTOKEN_API_LATEST

The most recent version of the EOS_Auth_QueryIdToken API.

ApiVersion

public int ApiVersion

API Version: Set this to EOS_AUTH_QUERYIDTOKEN_API_LATEST.

LocalUserId

public EOS_EpicAccountId LocalUserId

The Epic Account ID of the local authenticated user.

TargetAccountId

public EOS_EpicAccountId TargetAccountId

The target Epic Account ID for which to query an ID token. This account id may be the same as the input LocalUserId or another merged account id associated with the local user's Epic account.

An ID token for the selected account id of a locally authenticated user will always be readily available. To retrieve it for the selected account ID, you can use EOS_Auth_CopyIdToken directly after a successful user login.

Constructor Details

EOS_Auth_QueryIdTokenOptions

public EOS_Auth_QueryIdTokenOptions()

EOS_Auth_QueryIdTokenOptions

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