Package host.anzo.eossdk.eos.sdk.userinfo

Class EOS_UserInfo

java.lang.Object
com.sun.jna.Structure
host.anzo.eossdk.eos.sdk.userinfo.EOS_UserInfo
All Implemented Interfaces:
AutoCloseable
Direct Known Subclasses:
EOS_UserInfo.ByReference, EOS_UserInfo.ByValue
@FieldOrder({"ApiVersion","UserId","Country","DisplayName","PreferredLanguage","Nickname","DisplayNameSanitized"}) public class EOS_UserInfo extends com.sun.jna.Structure implements 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
    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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    int
    ApiVersion
    API Version: Set this to EOS_USERINFO_COPYUSERINFO_API_LATEST.
    String
    Country
    The name of the owner's country.
    String
    DisplayName
    The display name (un-sanitized).
    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.
    String
    Nickname
    A nickname/alias for the target user assigned by the local user.
    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
    Description
    EOS_UserInfo()
     
    EOS_UserInfo(com.sun.jna.Pointer peer)
     

  • Method Summary

    Modifier and Type
    Method
    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

  • Field Details

    • 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 String Country
      The name of the owner's country. This may be null

    • DisplayName

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

    • PreferredLanguage

      public String PreferredLanguage
      The ISO 639 language code for the user's preferred language. This may be null

    • Nickname

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

    • DisplayNameSanitized

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

  • Constructor Details

    • EOS_UserInfo

      public EOS_UserInfo()

    • EOS_UserInfo

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

  • Method Details