EOS_UserInfo (eossdk 1.18.0.4.1 API)

java.lang.Object
- com.sun.jna.Structure
- - host.anzo.eossdk.eos.sdk.userinfo.EOS_UserInfo

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

EOS_UserInfo.ByReference, EOS_UserInfo.ByValue
```
@Structure.FieldOrder(value={"ApiVersion","UserId","Country","DisplayName","PreferredLanguage","Nickname","DisplayNameSanitized"})
public class EOS_UserInfo
extends com.sun.jna.Structure
implements java.lang.AutoCloseable
```
A structure that contains the user information. These structures are created by EOS_UserInfo_CopyUserInfo and must be passed to EOS_UserInfo_Release.

Since:

9/3/2023

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class EOS_UserInfo.ByReference

static class EOS_UserInfo.ByValue
- Nested classes/interfaces inherited from class com.sun.jna.Structure
  com.sun.jna.Structure.FieldOrder, com.sun.jna.Structure.StructField

Nested Classes
Modifier and Type	Class and Description
`static class`	`EOS_UserInfo.ByReference`
`static class`	`EOS_UserInfo.ByValue`

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`ApiVersion` API Version: Set this to `EOS_USERINFO_COPYUSERINFO_API_LATEST`.
`java.lang.String`	`Country` The name of the owner's country.
`java.lang.String`	`DisplayName` The display name (un-sanitized).
`java.lang.String`	`DisplayNameSanitized` The raw display name (sanitized).
`static int`	`EOS_USERINFO_COPYUSERINFO_API_LATEST` The most recent version of the EOS_UserInfo_CopyUserInfo API.
`static int`	`EOS_USERINFO_MAX_DISPLAYNAME_CHARACTERS` The maximum length of display names, in displayable characters
`static int`	`EOS_USERINFO_MAX_DISPLAYNAME_UTF8_LENGTH` The maximum length of display names when encoded as UTF-8 as returned by EOS_UserInfo_CopyUserInfo.
`java.lang.String`	`Nickname` A nickname/alias for the target user assigned by the local user.
`java.lang.String`	`PreferredLanguage` The ISO 639 language code for the user's preferred language.
`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()

EOS_UserInfo(com.sun.jna.Pointer peer)

Constructors
Constructor and Description
`EOS_UserInfo()`
`EOS_UserInfo(com.sun.jna.Pointer peer)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

void close()

void release()
- 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`void`	`release()`

- Field Detail
  - EOS_USERINFO_MAX_DISPLAYNAME_CHARACTERS
```
public static int EOS_USERINFO_MAX_DISPLAYNAME_CHARACTERS
```
    The maximum length of display names, in displayable characters
  - EOS_USERINFO_MAX_DISPLAYNAME_UTF8_LENGTH
```
public static int EOS_USERINFO_MAX_DISPLAYNAME_UTF8_LENGTH
```
    The maximum length of display names when encoded as UTF-8 as returned by EOS_UserInfo_CopyUserInfo. This length does not include the null terminator.
  - EOS_USERINFO_COPYUSERINFO_API_LATEST
```
public static int EOS_USERINFO_COPYUSERINFO_API_LATEST
```
    The most recent version of the EOS_UserInfo_CopyUserInfo API.
  - ApiVersion
```
public int ApiVersion
```
    API Version: Set this to EOS_USERINFO_COPYUSERINFO_API_LATEST.
  - UserId
```
public EOS_EpicAccountId UserId
```
    The Epic Account ID of the user
  - Country
```
public java.lang.String Country
```
    The name of the owner's country. This may be null
  - DisplayName
```
public java.lang.String DisplayName
```
    The display name (un-sanitized). This may be null
  - PreferredLanguage
```
public java.lang.String PreferredLanguage
```
    The ISO 639 language code for the user's preferred language. 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
  - DisplayNameSanitized
```
public java.lang.String DisplayNameSanitized
```
    The raw display name (sanitized). This may be null
- Constructor Detail
  - EOS_UserInfo
```
public EOS_UserInfo()
```
  - EOS_UserInfo
```
public EOS_UserInfo(com.sun.jna.Pointer peer)
```
- Method Detail
  - release
```
public void release()
```
  - close
```
public void close()
           throws java.lang.Exception
```
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.lang.Exception

Class EOS_UserInfo

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.jna.Structure

Field Summary

Fields inherited from class com.sun.jna.Structure

Constructor Summary

Method Summary

Methods inherited from class com.sun.jna.Structure

Methods inherited from class java.lang.Object

Field Detail

EOS_USERINFO_MAX_DISPLAYNAME_CHARACTERS

EOS_USERINFO_MAX_DISPLAYNAME_UTF8_LENGTH

EOS_USERINFO_COPYUSERINFO_API_LATEST

ApiVersion

UserId

Country

DisplayName

PreferredLanguage

Nickname

DisplayNameSanitized

Constructor Detail

EOS_UserInfo

EOS_UserInfo

Method Detail

release

close