host.anzo.eossdk.eos.sdk.common

Class EOS_EpicAccountId

java.lang.Object

com.sun.jna.PointerType

host.anzo.eossdk.eos.sdk.common.EOS_EpicAccountId

All Implemented Interfaces:

com.sun.jna.NativeMapped

public class EOS_EpicAccountId
extends com.sun.jna.PointerType

A handle to a user's Epic Account ID This ID is associated with a specific login associated with Epic Account Services

Since:

8/5/2023

See Also:

EOS_Auth_Interface.login(EOS_Auth_LoginOptions, Pointer, EOS_Auth_OnLoginCallback)

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
EOS_EpicAccountId()
EOS_EpicAccountId(com.sun.jna.Pointer address)

Method Summary

Modifier and Type	Method and Description
static EOS_EpicAccountId	fromString(java.lang.String accountIdString) Retrieve an EOS_EpicAccountId from a raw string representing an Epic Account ID.
java.lang.String	getString() Retrieve a null-terminated stringified Epic Account ID from an EOS_EpicAccountId.
boolean	isValid() Check whether or not the given Epic Account ID is considered valid NOTE: This will return true for any EOS_EpicAccountId created with EOS_EpicAccountId_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 Detail

EOS_EPICACCOUNTID_MAX_LENGTH

public static int EOS_EPICACCOUNTID_MAX_LENGTH

A character buffer of this size is large enough to fit a successful output of EOS_EpicAccountId_ToString. This length does not include the null-terminator. The EpicAccountId data structure is opaque in nature and no assumptions of its structure should be inferred

Constructor Detail

EOS_EpicAccountId

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

EOS_EpicAccountId

public EOS_EpicAccountId()

Method Detail

fromString

public static EOS_EpicAccountId fromString(java.lang.String accountIdString)

Retrieve an EOS_EpicAccountId from a raw string representing an Epic Account 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_EpicAccountId_ToString

Parameters:

accountIdString - The stringified account ID for which to retrieve the Epic Account ID

Returns:

The EOS_EpicAccountId that corresponds to the AccountIdString

isValid

public boolean isValid()

Check whether or not the given Epic Account ID is considered valid NOTE: This will return true for any EOS_EpicAccountId created with EOS_EpicAccountId_FromString as there is no validation

Returns:

EOS_Bool.EOS_TRUE if the EOS_EpicAccountId is valid, otherwise EOS_Bool.EOS_FALSE

getString

public java.lang.String getString()
                           throws EOSException

Retrieve a null-terminated stringified Epic Account ID from an EOS_EpicAccountId. This is useful for replication of Epic Account IDs in multiplayer games. This string will be no larger than EOS_EPICACCOUNTID_MAX_LENGTH + 1 and will only contain UTF8-encoded printable characters as well as a null-terminator.

Returns:

Epic Account 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