host.anzo.eossdk.eos.sdk.userinfo

Class EOS_UserInfo_ExternalUserInfo

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.userinfo.EOS_UserInfo_ExternalUserInfo

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

EOS_UserInfo_ExternalUserInfo.ByReference, EOS_UserInfo_ExternalUserInfo.ByValue

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

Contains information about a single external user info.

Since:

9/3/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_UserInfo_ExternalUserInfo.ByReference
static class	EOS_UserInfo_ExternalUserInfo.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
java.lang.String	AccountId The ID of the external account.
EOS_EExternalAccountType	AccountType The type of the external account
int	ApiVersion API Version: Set this to EOS_USERINFO_EXTERNALUSERINFO_API_LATEST.
java.lang.String	DisplayName The display name of the external account (un-sanitized).
java.lang.String	DisplayNameSanitized The display name of the external account (sanitized).
static int	EOS_USERINFO_EXTERNALUSERINFO_API_LATEST The most recent version of the EOS_UserInfo_ExternalUserInfo struct.

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

Method Summary

Modifier and Type	Method and Description
void	close()
void	release() Release the memory associated with external user info.

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_USERINFO_EXTERNALUSERINFO_API_LATEST

public static final int EOS_USERINFO_EXTERNALUSERINFO_API_LATEST

The most recent version of the EOS_UserInfo_ExternalUserInfo struct.

See Also:

Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_USERINFO_EXTERNALUSERINFO_API_LATEST.

AccountType

public EOS_EExternalAccountType AccountType

The type of the external account

AccountId

public java.lang.String AccountId

The ID of the external account. Can be null

DisplayName

public java.lang.String DisplayName

The display name of the external account (un-sanitized). Can be null

DisplayNameSanitized

public java.lang.String DisplayNameSanitized

The display name of the external account (sanitized). Can be null

Constructor Detail

EOS_UserInfo_ExternalUserInfo

public EOS_UserInfo_ExternalUserInfo()

EOS_UserInfo_ExternalUserInfo

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

Method Detail

release

public void release()

Release the memory associated with external user info. This must be called on data retrieved from EOS_UserInfo_CopyExternalUserInfoByIndexOptions.

See Also:

EOS_UserInfo_ExternalUserInfo, EOS_UserInfo_Interface.copyExternalUserInfoByIndex(EOS_UserInfo_CopyExternalUserInfoByIndexOptions)

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception