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

Class EOS_Auth_PinGrantInfo

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.auth.EOS_Auth_PinGrantInfo

Direct Known Subclasses:

EOS_Auth_PinGrantInfo.ByReference, EOS_Auth_PinGrantInfo.ByValue

@FieldOrder({"ApiVersion","UserCode","VerificationURI","ExpiresIn","VerificationURIComplete"})
public class EOS_Auth_PinGrantInfo
extends com.sun.jna.Structure

Intermediate data needed to complete the EOS_LCT_DeviceCode and EOS_LCT_ExternalAuth login flows, returned by EOS_Auth_LoginCallbackInfo. The data inside should be exposed to the user for entry on a secondary device. All data must be copied out before the completion of this callback.

Since:

8/5/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EOS_Auth_PinGrantInfo.ByReference
static class	EOS_Auth_PinGrantInfo.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_PINGRANTINFO_API_LATEST.
static int	EOS_AUTH_PINGRANTINFO_API_LATEST	The most recent version of the EOS_Auth_PinGrantInfo struct.
int	ExpiresIn	Time the user has, in seconds, to complete the process or else timeout
String	UserCode	Code the user must input on an external device to activate the login
String	VerificationURI	The end-user verification URI.
String	VerificationURIComplete	A verification URI that includes the user code.

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_PinGrantInfo()
EOS_Auth_PinGrantInfo(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_PINGRANTINFO_API_LATEST

public static int EOS_AUTH_PINGRANTINFO_API_LATEST

The most recent version of the EOS_Auth_PinGrantInfo struct.

ApiVersion

public int ApiVersion

API Version: Set this to EOS_AUTH_PINGRANTINFO_API_LATEST.

UserCode

public String UserCode

Code the user must input on an external device to activate the login

VerificationURI

public String VerificationURI

The end-user verification URI. Users can be asked to manually type this into their browser.

ExpiresIn

public int ExpiresIn

Time the user has, in seconds, to complete the process or else timeout

VerificationURIComplete

public String VerificationURIComplete

A verification URI that includes the user code. Useful for non-textual transmission.

Constructor Details

EOS_Auth_PinGrantInfo

public EOS_Auth_PinGrantInfo()

EOS_Auth_PinGrantInfo

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