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
,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
FieldsModifier and TypeFieldDescriptionstatic final int
The maximum allowed length a data's key may be.static final int
The maximum of allowed individual pieces of data a user may have.static final int
The maximum allowed length a data's value may be.static final int
The maximum allowed length a user's rich text string may be.static final int
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
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.Modifies one or more rows of user-defined presence data for a local user.Sets your new join info custom game-data string.Modifies a user's Rich Presence string to a new state.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
-
Field Details
-
EOS_PRESENCE_DATA_MAX_KEYS
public static final int EOS_PRESENCE_DATA_MAX_KEYSThe 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:
-
EOS_PRESENCE_DATA_MAX_KEY_LENGTH
public static final int EOS_PRESENCE_DATA_MAX_KEY_LENGTHThe 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:
-
EOS_PRESENCE_DATA_MAX_VALUE_LENGTH
public static final int EOS_PRESENCE_DATA_MAX_VALUE_LENGTHThe 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:
-
EOS_PRESENCE_RICH_TEXT_MAX_VALUE_LENGTH
public static final int EOS_PRESENCE_RICH_TEXT_MAX_VALUE_LENGTHThe 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:
-
EOS_PRESENCEMODIFICATION_JOININFO_MAX_LENGTH
public static final int EOS_PRESENCEMODIFICATION_JOININFO_MAX_LENGTH- See Also:
-
-
Constructor Details
-
EOS_PresenceModification
public EOS_PresenceModification(com.sun.jna.Pointer address) -
EOS_PresenceModification
public EOS_PresenceModification()
-
-
Method Details
-
setStatus
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
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:
-
setData
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:
-
deleteData
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:
-
setJoinInfo
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:
-
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. -
close
- Specified by:
close
in interfaceAutoCloseable
- Throws:
Exception
-