The Group Presence API updates the platform with a user's current Destination::ApiName and status, whether they are GroupPresenceOptions.SetIsJoinable(), GroupPresenceOptions.SetLobbySessionId() and GroupPresenceOptions.SetMatchSessionId() information. A user's location can be shown both in VR and out of it on social platforms, and can highlight popular destinations in your app. Joinable means that a user is in an area of your app that supports other users playing with them.

Static Member Functions

static Request Clear ( )

Clears the current group presence settings for your app. Use this when a user’s group presence setting in your app needs to be changed when moving to new destinations in your app.

static Request< Models.UserList > GetInvitableUsers

( InviteOptions options )

Returns a list of users that can be invited to your current lobby. These are pulled from your bidirectional followers and recently met lists.

static Request< Models.ApplicationInviteList > GetSentInvites ( )

Get the application invites which have been sent by the user.

static Request< Models.InvitePanelResultInfo > LaunchInvitePanel

( InviteOptions options )

Launches the system invite dialog with a roster of eligible users for the current user to invite to the app. It is recommended that you surface a button in your UI that triggers this dialog when a user is joinable.

Parameters

options

It contains two methods. 1. Add InviteOptions.SetSuggestedUsers() - Takes the userID as a parameter and adds it to the inevitable users list. 2. Clear InviteOptions.SetSuggestedUsers() - Clears the inevitable users list.

static Request LaunchMultiplayerErrorDialog

( MultiplayerErrorOptions options )

Launch an error dialog window with predefined messages for commonly occurring multiplayer errors. Check the Invokable Error Dialogs documentation for more information about these error messages and their values.

Parameters

options

It contains a MultiplayerErrorOptions.SetErrorKey() associated with the predefined error message to be shown to users.

static Request< Models.RejoinDialogResult > LaunchRejoinDialog

( string lobby_session_id,

string match_session_id,

string destination_api_name )

Launch the dialog allowing users to rejoin a previous lobby or match. Either the user’s GroupPresenceOptions.SetLobbySessionId(), their GroupPresenceOptions.SetMatchSessionId(), or both must be populated as valid rejoinable destinations. Check the Rejoin documentation for use cases and information on this feature.

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.

static Request LaunchRosterPanel

( RosterOptions options )

Launch the panel displaying the current users in the roster. We do not recommend using this API because the list current users is surfaced in the Destination UI when the Meta Quest button is pressed.

Parameters

options

It contains 2 methods. 1. Add RosterOptions.SetSuggestedUsers() - it takes userID as a parameter and adds it to the inevitable users list. 2.Clear RosterOptions.SetSuggestedUsers() - it clears the inevitable users list.

static Request< Models.SendInvitesResult > SendInvites

( UInt64 [] userIDs )

Sends invites to the current application to the list of userIDs passed in. You can fetch a list of users to pass in via the GroupPresence.GetInvitableUsers(). This API works as an alternative to GroupPresence.LaunchInvitePanel() which delegates the invite flow to the system invite module. GroupPresence.LaunchInvitePanel() is the recommended approach.

Parameters

userIDs

userIDs is a list of users’ ids to send invites to.

static Request Set

( GroupPresenceOptions groupPresenceOptions )

Sets group presence information for your current app. It is recommended that you use this parameter and its methods to set group presence information for your app. An example of using this parameter can be found on the Group Presence overview page where the methods to set GroupPresenceOptions.SetDestinationApiName(), GroupPresenceOptions.SetMatchSessionId(), and GroupPresenceOptions.SetLobbySessionId() are used.

Parameters

groupPresenceOptions

The groupPresenceOptions parameter contains five methods. 1. GroupPresenceOptions.SetDeeplinkMessageOverride() - Use GroupPresenceOptions.SetLobbySessionId() or GroupPresenceOptions.SetMatchSessionId() to specify the session. Use the GroupPresenceOptions.SetDeeplinkMessageOverride() for any additional data in whatever format you wish to aid in bringing users together. If not specified, the deeplink_message for the user will default to the one on the destination. 2.GroupPresenceOptions.SetDestinationApiName() - This the unique API Name that refers to an in-app destination. 3.GroupPresenceOptions.SetIsJoinable() - Set whether or not the person is shown as joinable or not to others. A user that is joinable can invite others to join them. Set this to false if other users would not be able to join this user. For example, the current session is full, or only the host can invite others and the current user is not the host. 4.GroupPresenceOptions.SetLobbySessionId() - This is a session that represents a closer group/squad/party of users. It is expected that all users with the same lobby session id can see or hear each other. Users with the same lobby session id in their group presence will show up in the roster and will show up as "Recently Played With" for future invites if they aren't already Oculus friends. This must be set in addition to GroupPresenceOptions.SetIsJoinable() being true for a user to use invites. 5.GroupPresenceOptions.SetMatchSessionId() - This is a session that represents all the users that are playing a specific instance of a map, game mode, round, etc. This can include users from multiple different lobbies that joined together and the users may or may not remain together after the match is over. Users with the same match session id in their group presence will not show up in the Roster, but will show up as "Recently Played with" for future invites.

static Request SetDeeplinkMessageOverride

( string deeplink_message )

Sets the user's GroupPresenceOptions.SetDeeplinkMessageOverride() 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. This method does not power travel from the Meta Quest platform to your app. You must set a user’s GroupPresenceOptions.SetDestinationApiName(), GroupPresenceOptions.SetIsJoinable() status, and GroupPresenceOptions.SetLobbySessionId() to enable travel to your app. Check Group Presence overview for more information about these values. Note: Instead of using this standalone API, we recommend setting all GroupPresence parameters in one call to GroupPresence.Set().

Parameters

deeplink_message

deeplink_message is the new GroupPresenceOptions.SetDeeplinkMessageOverride() to set for the user, overriding the current deeplink message.

static Request SetDestination

( string api_name )

Replaces the user's current GroupPresenceOptions.SetDestinationApiName() with the provided one. Use this to set a user's current destination while keeping all the other Group Presence parameters the same. Setting a user's destination is required to enable travel from the Meta Quest Platform to your app. NOTE instead of using the standalone API, we recommend setting all GroupPresence parameters in one call to GroupPresence.Set(). This helps ensure that all relevant presence information is singularly updated and helps reduce presence errors.

Parameters

api_name

api_name is the unique name of the in-app desination to set, replacing the user's current GroupPresenceOptions.SetDestinationApiName().

static Request SetIsJoinable

( bool is_joinable )

Sets a user’s current presence as joinable. Use this method to update a user’s joinability as it changes. For example, when the game starts, the lobby becomes full, the user moves to a private, non joinable instance while keeping all other GroupPresence parameters (i.e GroupPresenceOptions.SetDestinationApiName(), GroupPresenceOptions.SetLobbySessionId(), GroupPresenceOptions.SetMatchSessionId()) the same. Setting a user’s destination is required to enable travel from the Meta Quest Platform to your app. Note: Instead of using this individual API, we recommend setting all GroupPresence information with the GroupPresence.Set() method and its associated parameters to simply managing all presence information. This helps ensure that all relevant presence information is singularly updated and helps reduce presence errors.

Parameters

is_joinable

If GroupPresenceOptions.SetIsJoinable() is 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.

static Request SetLobbySession

( string id )

Replaces the user's current GroupPresenceOptions.SetLobbySessionId() for the provided string. Use this to set a user's current lobby session id while keeping all other GroupPresence parameters the same. Setting a user's lobby session id is required to enable travel from the Meta Quest Platform to your app. Check Group presence overview for more information. NOTE instead of using the standalone API, we recommend setting all GroupPresence parameters in one call to GroupPresence.Set(). This helps ensure that all relevant presence information is singularly updated and helps reduce presence errors.

Parameters

id is the unique identifier of the lobby session to set, replacing the user's current GroupPresenceOptions.SetLobbySessionId().

static Request SetMatchSession

( string id )

Replaces the user's current GroupPresenceOptions.SetMatchSessionId() for the provided one. Use this to update the user's current match session id while keeping all other GroupPresence parameters the same. GroupPresenceOptions.SetMatchSessionId() works in conjuction with GroupPresenceOptions.SetLobbySessionId() to determine if users are playing together. If a user's match and lobby session ids are the same, they should be in the same multiplayer instance together. Users with the same lobby session id but different match session ids may be in the same lobby for things like voice chat while in different instances in your app. WARNING match session id is often treated the same as lobby session id, but this is in fact a distinct parameter and is not used for travel from the Meta Quest Platform. NOTE instead of using the standalone API, we recommend setting all GroupPresence parameters in one call to GroupPresence.Set().

Parameters

id is the unique identifier of the match session to set, replacing the user's current GroupPresenceOptions.SetMatchSessionId().

static void SetInvitationsSentNotificationCallback

( Message< Models.LaunchInvitePanelFlowResult >.Callback callback )

Sent when the user is finished using the invite panel to send out invitations. Contains a list of invitees. Parameter: Callback is a function that will be called when the invitation sent status changes. LaunchInvitePanelFlowResult has 1 member: UserList LaunchInvitePanelFlowResult::InvitedUsers - A list of users that were sent an invitation to the session.

static void SetJoinIntentReceivedNotificationCallback

( Message< Models.GroupPresenceJoinIntent >.Callback callback )

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. Parameter: Callback is a function that will be called when a user has chosen to join the destination/lobby/match. GroupPresenceJoinIntent has 4 members: string GroupPresenceJoinIntent::DeeplinkMessage - An opaque string provided by the developer to help them deeplink to content. string GroupPresenceJoinIntent::DestinationApiName - The destination the current user wants to go to. string GroupPresenceJoinIntent::LobbySessionId - The lobby session the current user wants to go to. string GroupPresenceJoinIntent::MatchSessionId - The match session the current user wants to go to.

static void SetLeaveIntentReceivedNotificationCallback

( Message< Models.GroupPresenceLeaveIntent >.Callback callback )

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. Parameter: Callback is a function that will be called when the user has chosen to leave the destination/lobby/match. GroupPresenceLeaveIntent has 3 members: string GroupPresenceLeaveIntent::DestinationApiName - The destination the current user wants to leave. string GroupPresenceLeaveIntent::LobbySessionId - The lobby session the current user wants to leave. string GroupPresenceLeaveIntent::MatchSessionId - The match session the current user wants to leave.

static Request< Models.ApplicationInviteList > GetNextApplicationInviteListPage

( Models.ApplicationInviteList list )

Did you find this page helpful?