host.anzo.eossdk.eos.sdk.presence

Class EOS_PresenceModification

java.lang.Object

com.sun.jna.PointerType

host.anzo.eossdk.eos.sdk.presence.EOS_PresenceModification

All Implemented Interfaces:

com.sun.jna.NativeMapped, java.lang.AutoCloseable

public class EOS_PresenceModification
extends com.sun.jna.PointerType
implements java.lang.AutoCloseable

To modify your own presence, you must call EOS_Presence_CreatePresenceModification to create a Presence Modification handle. To modify that handle, call EOS_PresenceModification_* methods. Once you are finished, call EOS_Presence_SetPresence with your handle. You must then release your Presence Modification handle by calling release().

Since:

8/22/2023

Field Summary

Fields

Modifier and Type	Field and Description
static int	EOS_PRESENCE_DATA_MAX_KEY_LENGTH The maximum allowed length a data's key may be.
static int	EOS_PRESENCE_DATA_MAX_KEYS The maximum of allowed individual pieces of data a user may have.
static int	EOS_PRESENCE_DATA_MAX_VALUE_LENGTH The maximum allowed length a data's value may be.
static int	EOS_PRESENCE_RICH_TEXT_MAX_VALUE_LENGTH The maximum allowed length a user's rich text string may be.
static int	EOS_PRESENCEMODIFICATION_JOININFO_MAX_LENGTH

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close()
EOS_EResult	deleteData(EOS_PresenceModification_DeleteDataOptions options) Removes one or more rows of user-defined presence data for a local user.
void	release() Release the memory associated with an EOS_HPresenceModification handle.
EOS_EResult	setData(EOS_PresenceModification_SetDataOptions options) Modifies one or more rows of user-defined presence data for a local user.
EOS_EResult	setJoinInfo(EOS_PresenceModification_SetJoinInfoOptions options) Sets your new join info custom game-data string.
EOS_EResult	setRawRichText(EOS_PresenceModification_SetRawRichTextOptions options) Modifies a user's Rich Presence string to a new state.
EOS_EResult	setStatus(EOS_PresenceModification_SetStatusOptions options) Modifies a user's online status to be the new state.

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_PRESENCE_DATA_MAX_KEYS

public static final int EOS_PRESENCE_DATA_MAX_KEYS

The maximum of allowed individual pieces of data a user may have. This value is subject to change and data structures should be designed to allow for greater numbers than this.

See Also:

Constant Field Values

EOS_PRESENCE_DATA_MAX_KEY_LENGTH

public static final int EOS_PRESENCE_DATA_MAX_KEY_LENGTH

The maximum allowed length a data's key may be. This value is subject to change and data structures should be designed to allow for greater numbers than this.

See Also:

Constant Field Values

EOS_PRESENCE_DATA_MAX_VALUE_LENGTH

public static final int EOS_PRESENCE_DATA_MAX_VALUE_LENGTH

The maximum allowed length a data's value may be. This value is subject to change and data structures should be designed to allow for greater numbers than this.

See Also:

Constant Field Values

EOS_PRESENCE_RICH_TEXT_MAX_VALUE_LENGTH

public static final int EOS_PRESENCE_RICH_TEXT_MAX_VALUE_LENGTH

The maximum allowed length a user's rich text string may be. This value is subject to change and data structures should be designed to allow for greater numbers than this.

See Also:

Constant Field Values

EOS_PRESENCEMODIFICATION_JOININFO_MAX_LENGTH

public static final int EOS_PRESENCEMODIFICATION_JOININFO_MAX_LENGTH

See Also:

Constant Field Values

Constructor Detail

EOS_PresenceModification

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

EOS_PresenceModification

public EOS_PresenceModification()

Method Detail

setStatus

public EOS_EResult setStatus(EOS_PresenceModification_SetStatusOptions options)

Modifies a user's online status to be the new state.

Parameters:

options - Object containing properties related to setting a user's Status

Returns:

EOS_EResult.EOS_Success if modification was added successfully, otherwise an error code related to the problem

setRawRichText

public EOS_EResult setRawRichText(EOS_PresenceModification_SetRawRichTextOptions options)

Modifies a user's Rich Presence string to a new state. This is the exact value other users will see when they query the local user's presence.

Parameters:

options - Object containing properties related to setting a user's RichText string

Returns:

EOS_EResult.EOS_Success if modification was added successfully, otherwise an error code related to the problem

See Also:

EOS_PRESENCE_RICH_TEXT_MAX_VALUE_LENGTH

setData

public EOS_EResult setData(EOS_PresenceModification_SetDataOptions options)

Modifies one or more rows of user-defined presence data for a local user. At least one InfoData object must be specified.

Parameters:

options - Object containing an array of new presence data.

Returns:

EOS_EResult.EOS_Success if modification was added successfully, otherwise an error code related to the problem

See Also:

EOS_PRESENCE_DATA_MAX_KEYS, EOS_PRESENCE_DATA_MAX_KEY_LENGTH, EOS_PRESENCE_DATA_MAX_VALUE_LENGTH

deleteData

public EOS_EResult deleteData(EOS_PresenceModification_DeleteDataOptions options)

Removes one or more rows of user-defined presence data for a local user. At least one DeleteDataInfo object must be specified.

Parameters:

options - Object containing an array of new presence data.

Returns:

EOS_EResult.EOS_Success if modification was added successfully, otherwise an error code related to the problem

See Also:

EOS_PRESENCE_DATA_MAX_KEYS, EOS_PRESENCE_DATA_MAX_KEY_LENGTH, EOS_PRESENCE_DATA_MAX_VALUE_LENGTH

setJoinInfo

public EOS_EResult setJoinInfo(EOS_PresenceModification_SetJoinInfoOptions options)

Sets your new join info custom game-data string. This is a helper function for reading the presence data related to how a user can be joined. Its meaning is entirely application dependent.

Parameters:

options - Object containing a join info string and associated user data

Returns:

EOS_EResult.EOS_Success if modification was added successfully, otherwise an error code related to the problem

See Also:

EOS_PRESENCEMODIFICATION_JOININFO_MAX_LENGTH

release

public void release()

Release the memory associated with an EOS_HPresenceModification handle. This must be called on Handles retrieved from EOS_Presence_CreatePresenceModification. This can be safely called on a NULL presence modification handle. This also may be safely called while a call to SetPresence is still pending.

See Also:

EOS_Presence_Interface.createPresenceModification(EOS_Presence_CreatePresenceModificationOptions, EOS_PresenceModification)

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception