host.anzo.eossdk.eos.sdk.auth

Class EOS_Auth_Credentials

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.auth.EOS_Auth_Credentials

Direct Known Subclasses:

EOS_Auth_Credentials.ByReference, EOS_Auth_Credentials.ByValue

@Structure.FieldOrder(value={"ApiVersion","Id","Token","Type","SystemAuthCredentialsOptions","ExternalType"})
public class EOS_Auth_Credentials
extends com.sun.jna.Structure

Since:

8/5/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_Auth_Credentials.ByReference
static class	EOS_Auth_Credentials.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
int	ApiVersion API Version: Set this to EOS_AUTH_CREDENTIALS_API_LATEST.
static int	EOS_AUTH_CREDENTIALS_API_LATEST The most recent version of the EOS_Auth_Credentials struct.
EOS_EExternalCredentialType	ExternalType Type of external login.
java.lang.String	Id ID of the user logging in, based on EOS_ELoginCredentialType
com.sun.jna.Pointer	SystemAuthCredentialsOptions This field is for system specific options, if any.
java.lang.String	Token Credentials or token related to the user logging in
EOS_ELoginCredentialType	Type Type of login.

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_Credentials()
EOS_Auth_Credentials(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 Detail

EOS_AUTH_CREDENTIALS_API_LATEST

public static int EOS_AUTH_CREDENTIALS_API_LATEST

The most recent version of the EOS_Auth_Credentials struct.

ApiVersion

public int ApiVersion

API Version: Set this to EOS_AUTH_CREDENTIALS_API_LATEST.

Id

public java.lang.String Id

ID of the user logging in, based on EOS_ELoginCredentialType

Token

public java.lang.String Token

Credentials or token related to the user logging in

Type

public EOS_ELoginCredentialType Type

Type of login. Needed to identify the auth method to use

SystemAuthCredentialsOptions

public com.sun.jna.Pointer SystemAuthCredentialsOptions

This field is for system specific options, if any.

If provided, the structure will be located in (System)/eos_(system).h. The structure will be named EOS_(System)_Auth_CredentialsOptions.

See Also:

EOS_IOS_Auth_CredentialsOptions

ExternalType

public EOS_EExternalCredentialType ExternalType

Type of external login. Needed to identify the external auth method to use. Used when login type is set to EOS_LCT_ExternalAuth, ignored for other EOS_ELoginCredentialType methods.

Constructor Detail

EOS_Auth_Credentials

public EOS_Auth_Credentials()

EOS_Auth_Credentials

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