host.anzo.eossdk.eos.sdk.userinfo

Class EOS_UserInfo_BestDisplayName

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.userinfo.EOS_UserInfo_BestDisplayName

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

EOS_UserInfo_BestDisplayName.ByReference, EOS_UserInfo_BestDisplayName.ByValue

@Structure.FieldOrder(value={"ApiVersion","UserId","DisplayName","DisplayNameSanitized","Nickname","PlatformType"})
public class EOS_UserInfo_BestDisplayName
extends com.sun.jna.Structure
implements java.lang.AutoCloseable

A structure that contains the user information. These structures are created by EOS_UserInfo_CopyBestDisplayName or EOS_UserInfo_CopyBestDisplayNameWithPlatform and must be passed to EOS_UserInfo_BestDisplayName_Release.

Since:

9/3/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_UserInfo_BestDisplayName.ByReference
static class	EOS_UserInfo_BestDisplayName.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_USERINFO_BESTDISPLAYNAME_API_LATEST.
java.lang.String	DisplayName The display name (un-sanitized).
java.lang.String	DisplayNameSanitized The raw display name (sanitized).
static int	EOS_USERINFO_BESTDISPLAYNAME_API_LATEST The most recent version of the EOS_UserInfo_BestDisplayName API.
java.lang.String	Nickname A nickname/alias for the target user assigned by the local user.
EOS_OnlinePlatformType	PlatformType The platform type for the user which corresponds to the display name
EOS_EpicAccountId	UserId The Epic Account ID of the user

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

Method Summary

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

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_BESTDISPLAYNAME_API_LATEST

public static final int EOS_USERINFO_BESTDISPLAYNAME_API_LATEST

The most recent version of the EOS_UserInfo_BestDisplayName API.

See Also:

Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_USERINFO_BESTDISPLAYNAME_API_LATEST.

UserId

public EOS_EpicAccountId UserId

The Epic Account ID of the user

DisplayName

public java.lang.String DisplayName

The display name (un-sanitized). This may be null

DisplayNameSanitized

public java.lang.String DisplayNameSanitized

The raw display name (sanitized). This may be null

Nickname

public java.lang.String Nickname

A nickname/alias for the target user assigned by the local user. This may be null

PlatformType

public EOS_OnlinePlatformType PlatformType

The platform type for the user which corresponds to the display name

Constructor Detail

EOS_UserInfo_BestDisplayName

public EOS_UserInfo_BestDisplayName()

EOS_UserInfo_BestDisplayName

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

Method Detail

release

public void release()

Release the memory associated with EOS_UserInfo_BestDisplayName. This must be called on data retrieved from EOS_UserInfo_CopyBestDisplayNameWithPlatform.

See Also:

EOS_UserInfo_Interface.copyBestDisplayName(EOS_UserInfo_CopyBestDisplayNameOptions), EOS_UserInfo_Interface.copyBestDisplayNameWithPlatform(EOS_UserInfo_CopyBestDisplayNameWithPlatformOptions)

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception