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

ovr_GroupPresence_Set Function

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 ovr_GroupPresenceOptions_SetDestinationApiName(), ovr_GroupPresenceOptions_SetMatchSessionId(), and ovr_GroupPresenceOptions_SetLobbySessionId() are used. ovrMessage_GroupPresence_Set will be generated in response.
First call ovr_Message_IsError() to check if an error occurred.
This response has no payload. If no error occurred, the request was successful. Yay!

Signature

ovrRequest ovr_GroupPresence_Set(ovrGroupPresenceOptionsHandle groupPresenceOptions)

Parameters

groupPresenceOptions: ovrGroupPresenceOptionsHandle The groupPresenceOptions parameter contains five methods. 1. ovr_GroupPresenceOptions_SetDeeplinkMessageOverride() - Use ovr_GroupPresenceOptions_SetLobbySessionId() or ovr_GroupPresenceOptions_SetMatchSessionId() to specify the session. Use the ovr_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.ovr_GroupPresenceOptions_SetDestinationApiName() - This the unique API Name that refers to an in-app destination. 3.ovr_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.ovr_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 ovr_GroupPresenceOptions_SetIsJoinable() being true for a user to use invites. 5.ovr_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.

Returns