Package host.anzo.eossdk.eos.sdk

Class EOS_Sessions_Interface

java.lang.Object

com.sun.jna.PointerType

host.anzo.eossdk.eos.sdk.EOS_Sessions_Interface

All Implemented Interfaces:

com.sun.jna.NativeMapped

public class EOS_Sessions_Interface
extends com.sun.jna.PointerType

The Session Interface is used to manage sessions that can be advertised with the backend service All Session Interface calls take a handle of type EOS_HSessions as the first parameter. This handle can be retrieved from an EOS_HPlatform handle by using the EOS_Platform_GetSessionsInterface function.

Since:

9/5/2023

See Also:

• EOS_Platform_Interface.getSessionsInterface()

Field Summary

Fields

Modifier and Type	Field	Description
static final int	EOS_SESSIONS_INVITEID_MAX_LENGTH	Max length of an invite ID

Constructor Summary

Constructors

Constructor	Description
EOS_Sessions_Interface()
EOS_Sessions_Interface(com.sun.jna.Pointer address)

Method Summary

Modifier and Type	Method	Description
EOS_NotificationId	addNotifyJoinSessionAccepted(EOS_Sessions_AddNotifyJoinSessionAcceptedOptions options, com.sun.jna.Pointer clientData, EOS_Sessions_OnJoinSessionAcceptedCallback notificationFn)	Register to receive notifications when a user accepts a session join game via the social overlay. Must call removeNotifyJoinSessionAccepted(EOS_NotificationId) to remove the notification
EOS_NotificationId	addNotifyLeaveSessionRequested(EOS_Sessions_AddNotifyLeaveSessionRequestedOptions options, com.sun.jna.Pointer clientData, EOS_Sessions_OnLeaveSessionRequestedCallback notificationFn)	Register to receive notifications about leave session requests performed by local user via the overlay.
EOS_NotificationId	addNotifySendSessionNativeInviteRequested(EOS_Sessions_AddNotifySendSessionNativeInviteRequestedOptions options, com.sun.jna.Pointer clientData, EOS_Sessions_OnSendSessionNativeInviteRequestedCallback notificationFn)	Register to receive notifications about a session "INVITE" performed by a local user via the overlay.
EOS_NotificationId	addNotifySessionInviteAccepted(EOS_Sessions_AddNotifySessionInviteAcceptedOptions options, com.sun.jna.Pointer clientData, EOS_Sessions_OnSessionInviteAcceptedCallback notificationFn)	Register to receive notifications when a user accepts a session invite via the social overlay. Must call removeNotifySessionInviteAccepted(EOS_NotificationId) to remove the notification
EOS_NotificationId	addNotifySessionInviteReceived(EOS_Sessions_AddNotifySessionInviteReceivedOptions options, com.sun.jna.Pointer clientData, EOS_Sessions_OnSessionInviteReceivedCallback notificationFn)	Register to receive session invites. Must call removeNotifySessionInviteReceived(EOS_NotificationId) to remove the notification
EOS_NotificationId	addNotifySessionInviteRejected(EOS_Sessions_AddNotifySessionInviteRejectedOptions options, com.sun.jna.Pointer clientData, EOS_Sessions_OnSessionInviteRejectedCallback notificationFn)	Register to receive notifications when a user rejects a session invite. Must call removeNotifySessionInviteRejected(EOS_NotificationId) to remove the notification
EOS_EResult	copyActiveSessionHandle(EOS_Sessions_CopyActiveSessionHandleOptions options, EOS_ActiveSession outSessionHandle)	Create a handle to an existing active session.
EOS_EResult	copySessionHandleByInviteId(EOS_Sessions_CopySessionHandleByInviteIdOptions options, EOS_SessionDetails outSessionHandle)	EOS_Sessions_CopySessionHandleByInviteId is used to immediately retrieve a handle to the session information from after notification of an invite If the call returns an EOS_Success result, the out parameter, OutSessionHandle, must be passed to EOS_SessionDetails_Release to release the memory associated with it.
EOS_EResult	copySessionHandleByUiEventId(EOS_Sessions_CopySessionHandleByUiEventIdOptions options, EOS_SessionDetails outSessionHandle)	EOS_Sessions_CopySessionHandleByUiEventId is used to immediately retrieve a handle to the session information from after notification of a join game event.
EOS_EResult	copySessionHandleForPresence(EOS_Sessions_CopySessionHandleForPresenceOptions options, EOS_SessionDetails outSessionHandle)	EOS_Sessions_CopySessionHandleForPresence is used to immediately retrieve a handle to the session information which was marked with bPresenceEnabled on create or join.
EOS_EResult	createSessionModification(EOS_Sessions_CreateSessionModificationOptions options, EOS_SessionModification outSessionModificationHandle)	Creates a session modification handle (EOS_SessionModification).
EOS_EResult	createSessionSearch(EOS_Sessions_CreateSessionSearchOptions options, EOS_SessionSearch outSessionSearchHandle)	Create a session search handle.
void	destroySession(EOS_Sessions_DestroySessionOptions options, com.sun.jna.Pointer clientData, EOS_Sessions_OnDestroySessionCallback completionDelegate)	Destroy a session given a session name
EOS_EResult	dumpSessionState(EOS_Sessions_DumpSessionStateOptions options)	Dump the contents of active sessions that exist locally to the log output, purely for debug purposes
void	endSession(EOS_Sessions_EndSessionOptions options, com.sun.jna.Pointer clientData, EOS_Sessions_OnEndSessionCallback completionDelegate)	Mark a session as ended, making it available to find if "join in progress" was disabled.
int	getInviteCount(EOS_Sessions_GetInviteCountOptions options)	Get the number of known invites for a given user
String	getInviteIdByIndex(EOS_Sessions_GetInviteIdByIndexOptions options)	Retrieve an invite ID from a list of active invites for a given user
EOS_EResult	isUserInSession(EOS_Sessions_IsUserInSessionOptions options)	EOS_Sessions_IsUserInSession returns whether or not a given user can be found in a specified session
void	joinSession(EOS_Sessions_JoinSessionOptions options, com.sun.jna.Pointer clientData, EOS_Sessions_OnJoinSessionCallback completionDelegate)	Join a session, creating a local session under a given session name.
void	queryInvites(EOS_Sessions_QueryInvitesOptions options, com.sun.jna.Pointer clientData, EOS_Sessions_OnQueryInvitesCallback completionDelegate)	Retrieve all existing invites for a single user
void	registerPlayers(EOS_Sessions_RegisterPlayersOptions options, com.sun.jna.Pointer clientData, EOS_Sessions_OnRegisterPlayersCallback completionDelegate)	Register a group of players with the session, allowing them to invite others or otherwise indicate they are part of the session for determining a full session
void	rejectInvite(EOS_Sessions_RejectInviteOptions options, com.sun.jna.Pointer clientData, EOS_Sessions_OnRejectInviteCallback completionDelegate)	Reject an invite from another player.
void	removeNotifyJoinSessionAccepted(EOS_NotificationId inId)	Unregister from receiving notifications when a user accepts a session join game via the social overlay.
void	removeNotifyLeaveSessionRequested(EOS_NotificationId inId)	Unregister from receiving notifications when a user performs a leave lobby action via the overlay.
void	removeNotifySendSessionNativeInviteRequested(EOS_NotificationId inId)	Unregister from receiving notifications when a user requests a send invite via the overlay.
void	removeNotifySessionInviteAccepted(EOS_NotificationId inId)	Unregister from receiving notifications when a user accepts a session invite via the social overlay.
void	removeNotifySessionInviteReceived(EOS_NotificationId inId)	Unregister from receiving session invites.
void	removeNotifySessionInviteRejected(EOS_NotificationId inId)	Unregister from receiving notifications when a user rejects a session invite via the social overlay.
void	sendInvite(EOS_Sessions_SendInviteOptions options, com.sun.jna.Pointer clientData, EOS_Sessions_OnSendInviteCallback completionDelegate)	Send an invite to another player.
void	startSession(EOS_Sessions_StartSessionOptions options, com.sun.jna.Pointer clientData, EOS_Sessions_OnStartSessionCallback completionDelegate)	Mark a session as started, making it unable to find if session properties indicate "join in progress" is not available
void	unregisterPlayers(EOS_Sessions_UnregisterPlayersOptions options, com.sun.jna.Pointer clientData, EOS_Sessions_OnUnregisterPlayersCallback completionDelegate)	Unregister a group of players with the session, freeing up space for others to join
void	updateSession(EOS_Sessions_UpdateSessionOptions options, com.sun.jna.Pointer clientData, EOS_Sessions_OnUpdateSessionCallback completionDelegate)	Update a session given a session modification handle created by EOS_Sessions_CreateSessionModification or EOS_Sessions_UpdateSessionModification
EOS_EResult	updateSessionModification(EOS_Sessions_UpdateSessionModificationOptions options, EOS_SessionModification outSessionModificationHandle)	Creates a session modification handle (EOS_SessionModification).

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_SESSIONS_INVITEID_MAX_LENGTH

public static final int EOS_SESSIONS_INVITEID_MAX_LENGTH

Max length of an invite ID

See Also:

• Constant Field Values

Constructor Details

EOS_Sessions_Interface

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

EOS_Sessions_Interface

public EOS_Sessions_Interface()

Method Details

createSessionModification

public EOS_EResult createSessionModification(EOS_Sessions_CreateSessionModificationOptions options,
 EOS_SessionModification outSessionModificationHandle)

Creates a session modification handle (EOS_SessionModification). The session modification handle is used to build a new session and can be applied with EOS_Sessions_UpdateSession The EOS_SessionModification must be released by calling EOS_SessionModification_Release once it no longer needed.

Parameters:

options - Required fields for the creation of a session such as a name, bucketid, and max players

outSessionModificationHandle - Pointer to a Session Modification Handle only set if successful

Returns:

EOS_EResult.EOS_Success if we successfully created the Session Modification Handle pointed at in outSessionModificationHandle, or an error result if the input data was invalid

See Also:

• EOS_SessionModification.release()
• updateSession(EOS_Sessions_UpdateSessionOptions, Pointer, EOS_Sessions_OnUpdateSessionCallback)
• EOS_SessionModification

updateSessionModification

public EOS_EResult updateSessionModification(EOS_Sessions_UpdateSessionModificationOptions options,
 EOS_SessionModification outSessionModificationHandle)

Creates a session modification handle (EOS_SessionModification). The session modification handle is used to modify an existing session and can be applied with EOS_Sessions_UpdateSession. The EOS_SessionModification must be released by calling EOS_SessionModification_Release once it is no longer needed.

Parameters:

options - Required fields such as session name

outSessionModificationHandle - Pointer to a Session Modification Handle only set if successful

Returns:

EOS_EResult.EOS_Success if we successfully created the Session Modification Handle pointed at in outSessionModificationHandle, or an error result if the input data was invalid

See Also:

• EOS_SessionModification.release()
• updateSession(EOS_Sessions_UpdateSessionOptions, Pointer, EOS_Sessions_OnUpdateSessionCallback)
• EOS_SessionModification

updateSession

public void updateSession(EOS_Sessions_UpdateSessionOptions options,
 com.sun.jna.Pointer clientData,
 EOS_Sessions_OnUpdateSessionCallback completionDelegate)

Update a session given a session modification handle created by EOS_Sessions_CreateSessionModification or EOS_Sessions_UpdateSessionModification

Parameters:

options - Structure containing information about the session to be updated

clientData - Arbitrary data that is passed back to you in the completionDelegate

completionDelegate - A callback that is fired when the update operation completes, either successfully or in error

destroySession

public void destroySession(EOS_Sessions_DestroySessionOptions options,
 com.sun.jna.Pointer clientData,
 EOS_Sessions_OnDestroySessionCallback completionDelegate)

Destroy a session given a session name

Parameters:

options - Structure containing information about the session to be destroyed

clientData - Arbitrary data that is passed back to you in the completionDelegate

completionDelegate - A callback that is fired when the destroy operation completes, either successfully or in error

joinSession

public void joinSession(EOS_Sessions_JoinSessionOptions options,
 com.sun.jna.Pointer clientData,
 EOS_Sessions_OnJoinSessionCallback completionDelegate)

Join a session, creating a local session under a given session name. Backend will validate various conditions to make sure it is possible to join the session.

Parameters:

options - Structure containing information about the session to be joined

clientData - Arbitrary data that is passed back to you in the completionDelegate

completionDelegate - A callback that is fired when the join operation completes, either successfully or in error

startSession

public void startSession(EOS_Sessions_StartSessionOptions options,
 com.sun.jna.Pointer clientData,
 EOS_Sessions_OnStartSessionCallback completionDelegate)

Mark a session as started, making it unable to find if session properties indicate "join in progress" is not available

Parameters:

options - Structure containing information about the session to be started

clientData - Arbitrary data that is passed back to you in the completionDelegate

completionDelegate - A callback that is fired when the start operation completes, either successfully or in error

endSession

public void endSession(EOS_Sessions_EndSessionOptions options,
 com.sun.jna.Pointer clientData,
 EOS_Sessions_OnEndSessionCallback completionDelegate)

Mark a session as ended, making it available to find if "join in progress" was disabled. The session may be started again if desired

Parameters:

options - Structure containing information about the session to be ended

clientData - Arbitrary data that is passed back to you in the completionDelegate

completionDelegate - A callback that is fired when the end operation completes, either successfully or in error

registerPlayers

public void registerPlayers(EOS_Sessions_RegisterPlayersOptions options,
 com.sun.jna.Pointer clientData,
 EOS_Sessions_OnRegisterPlayersCallback completionDelegate)

Register a group of players with the session, allowing them to invite others or otherwise indicate they are part of the session for determining a full session

Parameters:

options - Structure containing information about the session and players to be registered

clientData - Arbitrary data that is passed back to you in the completionDelegate

completionDelegate - A callback that is fired when the registration operation completes, either successfully or in error

unregisterPlayers

public void unregisterPlayers(EOS_Sessions_UnregisterPlayersOptions options,
 com.sun.jna.Pointer clientData,
 EOS_Sessions_OnUnregisterPlayersCallback completionDelegate)

Unregister a group of players with the session, freeing up space for others to join

Parameters:

options - Structure containing information about the session and players to be unregistered

clientData - Arbitrary data that is passed back to you in the completionDelegate

completionDelegate - A callback that is fired when the unregistration operation completes, either successfully or in error

sendInvite

public void sendInvite(EOS_Sessions_SendInviteOptions options,
 com.sun.jna.Pointer clientData,
 EOS_Sessions_OnSendInviteCallback completionDelegate)

Send an invite to another player. User must have created the session or be registered in the session or else the call will fail

Parameters:

options - Structure containing information about the session and player to invite

clientData - Arbitrary data that is passed back to you in the completionDelegate

completionDelegate - A callback that is fired when the send invite operation completes, either successfully or in error

rejectInvite

public void rejectInvite(EOS_Sessions_RejectInviteOptions options,
 com.sun.jna.Pointer clientData,
 EOS_Sessions_OnRejectInviteCallback completionDelegate)

Reject an invite from another player.

Parameters:

options - Structure containing information about the invite to reject

clientData - Arbitrary data that is passed back to you in the completionDelegate

completionDelegate - A callback that is fired when the reject invite operation completes, either successfully or in error

queryInvites

public void queryInvites(EOS_Sessions_QueryInvitesOptions options,
 com.sun.jna.Pointer clientData,
 EOS_Sessions_OnQueryInvitesCallback completionDelegate)

Retrieve all existing invites for a single user

Parameters:

options - Structure containing information about the invites to query

clientData - Arbitrary data that is passed back to you in the completionDelegate

completionDelegate - A callback that is fired when the query invites operation completes, either successfully or in error

getInviteCount

public int getInviteCount(EOS_Sessions_GetInviteCountOptions options)

Get the number of known invites for a given user

Parameters:

options - the options associated with retrieving the current invite count

Returns:

number of known invites for a given user or 0 if there is an error

getInviteIdByIndex

public String getInviteIdByIndex(EOS_Sessions_GetInviteIdByIndexOptions options)
                          throws EOSException

Retrieve an invite ID from a list of active invites for a given user

Parameters:

options - Structure containing the input parameters

Returns:

invite ID

Throws:

EOSInvalidParametersException - if any of the options are incorrect

EOSNotFoundException - if the invite doesn't exist

EOSException

See Also:

• getInviteCount(EOS_Sessions_GetInviteCountOptions)
• copySessionHandleByInviteId(EOS_Sessions_CopySessionHandleByInviteIdOptions, EOS_SessionDetails)

createSessionSearch

public EOS_EResult createSessionSearch(EOS_Sessions_CreateSessionSearchOptions options,
 EOS_SessionSearch outSessionSearchHandle)

Create a session search handle. This handle may be modified to include various search parameters. Searching is possible in three methods, all mutually exclusive

• set the session ID to find a specific session
• set the target user ID to find a specific user
• set session parameters to find an array of sessions that match the search criteria

Parameters:

options - Structure containing required parameters such as the maximum number of search results

outSessionSearchHandle - The new search handle or null if there was an error creating the search handle

Returns:

EOS_EResult.EOS_Success if the search creation completes successfully
EOS_EResult.EOS_InvalidParameters if any of the options are incorrect

copyActiveSessionHandle

public EOS_EResult copyActiveSessionHandle(EOS_Sessions_CopyActiveSessionHandleOptions options,
 EOS_ActiveSession outSessionHandle)

Create a handle to an existing active session.

Parameters:

options - Structure containing information about the active session to retrieve

outSessionHandle - The new active session handle or null if there was an error

Returns:

EOS_EResult.EOS_Success if the session handle was created successfully
EOS_EResult.EOS_InvalidParameters if any of the options are incorrect
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect
EOS_EResult.EOS_NotFound if the active session doesn't exist

addNotifySessionInviteReceived

public EOS_NotificationId addNotifySessionInviteReceived(EOS_Sessions_AddNotifySessionInviteReceivedOptions options,
 com.sun.jna.Pointer clientData,
 EOS_Sessions_OnSessionInviteReceivedCallback notificationFn)

Register to receive session invites.
Must call removeNotifySessionInviteReceived(EOS_NotificationId) to remove the notification

Parameters:

options - Structure containing information about the session invite notification

clientData - Arbitrary data that is passed back to you in the completionDelegate

notificationFn - A callback that is fired when a session invite for a user has been received

Returns:

handle representing the registered callback

removeNotifySessionInviteReceived

public void removeNotifySessionInviteReceived(EOS_NotificationId inId)

Unregister from receiving session invites.

Parameters:

inId - Handle representing the registered callback

addNotifySessionInviteAccepted

public EOS_NotificationId addNotifySessionInviteAccepted(EOS_Sessions_AddNotifySessionInviteAcceptedOptions options,
 com.sun.jna.Pointer clientData,
 EOS_Sessions_OnSessionInviteAcceptedCallback notificationFn)

Register to receive notifications when a user accepts a session invite via the social overlay.
Must call removeNotifySessionInviteAccepted(EOS_NotificationId) to remove the notification

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the completionDelegate.

notificationFn - A callback that is fired when a notification is received.

Returns:

handle representing the registered callback

removeNotifySessionInviteAccepted

public void removeNotifySessionInviteAccepted(EOS_NotificationId inId)

Unregister from receiving notifications when a user accepts a session invite via the social overlay.

Parameters:

inId - Handle representing the registered callback

addNotifySessionInviteRejected

public EOS_NotificationId addNotifySessionInviteRejected(EOS_Sessions_AddNotifySessionInviteRejectedOptions options,
 com.sun.jna.Pointer clientData,
 EOS_Sessions_OnSessionInviteRejectedCallback notificationFn)

Register to receive notifications when a user rejects a session invite.
Must call removeNotifySessionInviteRejected(EOS_NotificationId) to remove the notification

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the completionDelegate.

notificationFn - A callback that is fired when a notification is received.

Returns:

handle representing the registered callback

removeNotifySessionInviteRejected

public void removeNotifySessionInviteRejected(EOS_NotificationId inId)

Unregister from receiving notifications when a user rejects a session invite via the social overlay.

Parameters:

inId - Handle representing the registered callback

addNotifyJoinSessionAccepted

public EOS_NotificationId addNotifyJoinSessionAccepted(EOS_Sessions_AddNotifyJoinSessionAcceptedOptions options,
 com.sun.jna.Pointer clientData,
 EOS_Sessions_OnJoinSessionAcceptedCallback notificationFn)

Register to receive notifications when a user accepts a session join game via the social overlay.
Must call removeNotifyJoinSessionAccepted(EOS_NotificationId) to remove the notification

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the completionDelegate.

notificationFn - A callback that is fired when a notification is received.

Returns:

handle representing the registered callback

removeNotifyJoinSessionAccepted

public void removeNotifyJoinSessionAccepted(EOS_NotificationId inId)

Unregister from receiving notifications when a user accepts a session join game via the social overlay.

Parameters:

inId - Handle representing the registered callback

copySessionHandleByInviteId

public EOS_EResult copySessionHandleByInviteId(EOS_Sessions_CopySessionHandleByInviteIdOptions options,
 EOS_SessionDetails outSessionHandle)

EOS_Sessions_CopySessionHandleByInviteId is used to immediately retrieve a handle to the session information from after notification of an invite If the call returns an EOS_Success result, the out parameter, OutSessionHandle, must be passed to EOS_SessionDetails_Release to release the memory associated with it.

Parameters:

options - Structure containing the input parameters

outSessionHandle - out parameter used to receive the session handle

Returns:

EOS_EResult.EOS_Success if the information is available and passed out in outSessionHandle
EOS_EResult.EOS_InvalidParameters if you pass an invalid invite ID or a null pointer for the out parameter
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect
EOS_EResult.EOS_NotFound if the invite ID cannot be found

See Also:

• EOS_Sessions_CopySessionHandleByInviteIdOptions
• EOS_SessionDetails.release()

copySessionHandleByUiEventId

public EOS_EResult copySessionHandleByUiEventId(EOS_Sessions_CopySessionHandleByUiEventIdOptions options,
 EOS_SessionDetails outSessionHandle)

EOS_Sessions_CopySessionHandleByUiEventId is used to immediately retrieve a handle to the session information from after notification of a join game event. If the call returns an EOS_Success result, the out parameter, OutSessionHandle, must be passed to EOS_SessionDetails_Release to release the memory associated with it.

Parameters:

options - Structure containing the input parameters

outSessionHandle - out parameter used to receive the session handle

Returns:

EOS_EResult.EOS_Success if the information is available and passed out in OutSessionHandle
EOS_EResult.EOS_InvalidParameters if you pass an invalid invite ID or a null pointer for the out parameter
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect
EOS_EResult.EOS_NotFound if the invite ID cannot be found

See Also:

• EOS_Sessions_CopySessionHandleByUiEventIdOptions
• EOS_SessionDetails.release()

copySessionHandleForPresence

public EOS_EResult copySessionHandleForPresence(EOS_Sessions_CopySessionHandleForPresenceOptions options,
 EOS_SessionDetails outSessionHandle)

EOS_Sessions_CopySessionHandleForPresence is used to immediately retrieve a handle to the session information which was marked with bPresenceEnabled on create or join. If the call returns an EOS_Success result, the out parameter, OutSessionHandle, must be passed to EOS_SessionDetails_Release to release the memory associated with it.

Parameters:

options - Structure containing the input parameters

outSessionHandle - out parameter used to receive the session handle

Returns:

EOS_EResult.EOS_Success if the information is available and passed out in OutSessionHandle
EOS_EResult.EOS_InvalidParameters if you pass an invalid invite ID or a null pointer for the out parameter
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect
EOS_EResult.EOS_NotFound if there is no session with bPresenceEnabled

See Also:

• EOS_Sessions_CopySessionHandleForPresenceOptions
• EOS_SessionDetails.release()

isUserInSession

public EOS_EResult isUserInSession(EOS_Sessions_IsUserInSessionOptions options)

EOS_Sessions_IsUserInSession returns whether or not a given user can be found in a specified session

Parameters:

options - Structure containing the input parameters

Returns:

EOS_EResult.EOS_Success if the user is found in the specified session
EOS_EResult.EOS_NotFound if the user is not found in the specified session
EOS_EResult.EOS_InvalidParameters if you pass an invalid invite ID or a null pointer for the out parameter
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect
EOS_EResult.EOS_Invalid_ProductUserID if an invalid target user is specified
EOS_EResult.EOS_Sessions_InvalidSession if the session specified is invalid

dumpSessionState

public EOS_EResult dumpSessionState(EOS_Sessions_DumpSessionStateOptions options)

Dump the contents of active sessions that exist locally to the log output, purely for debug purposes

Parameters:

options - Options related to dumping session state such as the session name

Returns:

EOS_EResult.EOS_Success if the output operation completes successfully
EOS_EResult.EOS_NotFound if the session specified does not exist
EOS_EResult.EOS_InvalidParameters if any of the options are incorrect

addNotifyLeaveSessionRequested

public EOS_NotificationId addNotifyLeaveSessionRequested(EOS_Sessions_AddNotifyLeaveSessionRequestedOptions options,
 com.sun.jna.Pointer clientData,
 EOS_Sessions_OnLeaveSessionRequestedCallback notificationFn)

Register to receive notifications about leave session requests performed by local user via the overlay. When user requests to leave the session in the social overlay, the SDK does not automatically leave the session, it is up to the game to perform any necessary cleanup and call the EOS_Sessions_DestroySession method using the SessionName sent in the notification function.
Must call removeNotifyLeaveSessionRequested(EOS_NotificationId) to remove the notification.

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the completionDelegate.

notificationFn - A callback that is fired when a notification is received.

Returns:

handle representing the registered callback

removeNotifyLeaveSessionRequested

public void removeNotifyLeaveSessionRequested(EOS_NotificationId inId)

Unregister from receiving notifications when a user performs a leave lobby action via the overlay.

Parameters:

inId - Handle representing the registered callback

addNotifySendSessionNativeInviteRequested

public EOS_NotificationId addNotifySendSessionNativeInviteRequested(EOS_Sessions_AddNotifySendSessionNativeInviteRequestedOptions options,
 com.sun.jna.Pointer clientData,
 EOS_Sessions_OnSendSessionNativeInviteRequestedCallback notificationFn)

Register to receive notifications about a session "INVITE" performed by a local user via the overlay. This is only needed when a configured integrated platform has EOS_IPMF_DisableSDKManagedSessions set. The EOS SDK will then use the state of EOS_IPMF_PreferEOSIdentity and EOS_IPMF_PreferIntegratedIdentity to determine when the notificationFn is called.
Must call removeNotifySendSessionNativeInviteRequested(EOS_NotificationId) to remove the notification.

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the completionDelegate.

notificationFn - A callback that is fired when a notification is received.

Returns:

handle representing the registered callback

See Also:

• EOS_EIntegratedPlatformManagementFlags.EOS_IPMF_DisableSDKManagedSessions
• EOS_EIntegratedPlatformManagementFlags.EOS_IPMF_PreferEOSIdentity
• EOS_EIntegratedPlatformManagementFlags.EOS_IPMF_PreferIntegratedIdentity

removeNotifySendSessionNativeInviteRequested

public void removeNotifySendSessionNativeInviteRequested(EOS_NotificationId inId)

Unregister from receiving notifications when a user requests a send invite via the overlay.

Parameters:

inId - Handle representing the registered callback