Package host.anzo.eossdk.eos.sdk.common

Class EOS_ProductUserId

java.lang.Object
com.sun.jna.PointerType
host.anzo.eossdk.eos.sdk.common.EOS_ProductUserId
All Implemented Interfaces:
com.sun.jna.NativeMapped
public class EOS_ProductUserId extends com.sun.jna.PointerType
A handle to a user's Product User ID (game services related ecosystem) This ID is associated with any of the external account providers (of which Epic Account Services is one)
Since:
8/5/2023
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static int
    EOS_PRODUCTUSERID_MAX_LENGTH
    A character buffer of this size is large enough to fit a successful output of EOS_ProductUserId_ToString.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EOS_ProductUserId()
     
    EOS_ProductUserId(com.sun.jna.Pointer address)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static EOS_ProductUserId
    fromString(String productUserIdString)
    Retrieve an EOS_ProductUserId from a raw string representing an Epic Online Services Product User ID.
    String
    getString()
    Retrieve a null-terminated stringified Product User ID from an EOS_ProductUserId.
    boolean
    isValid()
    Check whether or not the given account unique ID is considered valid NOTE: This will return true for any EOS_ProductUserId created with EOS_ProductUserId_FromString as there is no validation

    Methods inherited from class com.sun.jna.PointerType

    equals, fromNative, getPointer, hashCode, nativeType, setPointer, toNative, toString

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • EOS_PRODUCTUSERID_MAX_LENGTH

      public static int EOS_PRODUCTUSERID_MAX_LENGTH
      A character buffer of this size is large enough to fit a successful output of EOS_ProductUserId_ToString. This length does not include the null-terminator.

  • Constructor Details

    • EOS_ProductUserId

      public EOS_ProductUserId(com.sun.jna.Pointer address)

    • EOS_ProductUserId

      public EOS_ProductUserId()

  • Method Details

    • fromString

      public static EOS_ProductUserId fromString(String productUserIdString)
      Retrieve an EOS_ProductUserId from a raw string representing an Epic Online Services Product User ID. The input string must be null-terminated. NOTE: There is no validation on the string format, this should only be used with values serialized from legitimate sources such as EOS_ProductUserId_ToString
      Parameters:
      productUserIdString - The stringified product user ID for which to retrieve the Epic Online Services Product User ID
      Returns:
      The EOS_ProductUserId that corresponds to the ProductUserIdString

    • isValid

      public boolean isValid()
      Check whether or not the given account unique ID is considered valid NOTE: This will return true for any EOS_ProductUserId created with EOS_ProductUserId_FromString as there is no validation
      Returns:
      EOS_Bool.EOS_TRUE if the EOS_ProductUserId is valid, otherwise EOS_Bool.EOS_FALSE

    • getString

      public String getString() throws EOSException
      Retrieve a null-terminated stringified Product User ID from an EOS_ProductUserId. This is useful for replication of Product User IDs in multiplayer games. This string will be no larger than EOS_PRODUCTUSERID_MAX_LENGTH + 1 and will only contain UTF8-encoded printable characters as well as the null-terminator.
      Returns:
      The Product User ID stringified version
      Throws:
      EOSInvalidParametersException - Either OutBuffer or InOutBufferLength were passed as NULL parameters.
      EOSInvalidUserException - The AccountId is invalid and cannot be stringified.
      EOSLimitExceededException - The OutBuffer is not large enough to receive the Product User ID string. InOutBufferLength contains the required minimum length to perform the operation successfully.
      EOSException