API reference
API reference
Select your platform
No SDKs available
No versions available

GroupPresence Class

Static Member Functions

Clear group presence for running app
Returns a list of users that can be invited to your current lobby. These are pulled from your bidirectional followers and recently met lists.
Get the application invites which have been sent by the user.
Launch the flow to allow the user to invite others to their current session. This can only be used if the user is in a joinable session.
Launch an error dialog with predefined messages for common multiplayer errors.
Launch the dialog which will allow the user to rejoin a previous lobby/match. Either the lobby_session_id or the match_session_id, or both, must be populated.
Parameters
lobby_session_id
The unique identifier of the lobby session to rejoin.
match_session_id
The unique identifier of the match session to rejoin.
destination_api_name
The unique name of the in-app destination to rejoin.
Launch the panel which displays the current users in the roster. Users with the same lobby and match session id as part of their presence will show up here.
Send application invites to the passed in userIDs.
Parameters
userIDs
Defines a list of user ids to get entries for.
Set group presence for running app
Set the user's deeplink message while keeping the other group presence parameters the same. If the destination of the user is not set, the deeplink message cannot be set as there's no deeplink message to override.
Parameters
deeplink_message
The new deeplink message to set for the user, overriding the current deeplink message.
Replaces the user's current destination for the provided one. All other existing group presence parameters will remain the same.
Parameters
api_name
The unique name of the in-app destination to set, replacing the user's current destination.
Set if the current user's destination and session is joinable while keeping the other group presence parameters the same. If the destination or session ids of the user is not set, they cannot be set to joinable.
Parameters
is_joinable
If true, the user can invite others to join them. If false, other users cannot join this user, for example, if the current session is full or only the host can invite others and the current user is not the host.
Replaces the user's current lobby session id for the provided one. All other existing group presence parameters will remain the same.
Parameters
id
The unique identifier of the lobby session to set, replacing the user's current lobby session id.
Replaces the user's current match session id for the provided one. All other existing group presence parameters will remain the same.
Parameters
id
The unique identifier of the match session to set, replacing the user's current match session id.
Sent when the user is finished using the invite panel to send out invitations. Contains a list of invitees.
Sent when a user has chosen to join the destination/lobby/match. Read all the fields to figure out where the user wants to go and take the appropriate actions to bring them there. If the user is unable to go there, provide adequate messaging to the user on why they cannot go there. These notifications should be responded to immediately.
Sent when the user has chosen to leave the destination/lobby/match from the Oculus menu. Read the specific fields to check the user is currently from the destination/lobby/match and take the appropriate actions to remove them. Update the user's presence clearing the appropriate fields to indicate the user has left.
static Request< Models.ApplicationInviteList > GetNextApplicationInviteListPage
Did you find this page helpful?
Thumbs up icon
Thumbs down icon