API reference

OVR_Requests_GroupPresence.h File

Functions

ovrRequest ovr_GroupPresence_Clear ( )
Clear group presence for running appA message with type ovrMessage_GroupPresence_Clear 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!
ovrRequest ovr_GroupPresence_GetInvitableUsers
Returns a list of users that can be invited to your current lobby. These are pulled from your bidirectional followers and recently met lists.A message with type ovrMessage_GroupPresence_GetInvitableUsers will be generated in response.First call ovr_Message_IsError() to check if an error occurred.If no error occurred, the message will contain a payload of type ovrUserArrayHandle. Extract the payload from the message handle with ovr_Message_GetUserArray().
ovrRequest ovr_GroupPresence_GetNextApplicationInviteArrayPage
Get the next page of entriesA message with type ovrMessage_GroupPresence_GetNextApplicationInviteArrayPage will be generated in response.First call ovr_Message_IsError() to check if an error occurred.If no error occurred, the message will contain a payload of type ovrApplicationInviteArrayHandle. Extract the payload from the message handle with ovr_Message_GetApplicationInviteArray().
ovrRequest ovr_GroupPresence_GetSentInvites ( )
Get the application invites which have been sent by the user.A message with type ovrMessage_GroupPresence_GetSentInvites will be generated in response.First call ovr_Message_IsError() to check if an error occurred.If no error occurred, the message will contain a payload of type ovrApplicationInviteArrayHandle. Extract the payload from the message handle with ovr_Message_GetApplicationInviteArray().
ovrRequest ovr_GroupPresence_LaunchInvitePanel
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.A message with type ovrMessage_GroupPresence_LaunchInvitePanel will be generated in response.First call ovr_Message_IsError() to check if an error occurred.If no error occurred, the message will contain a payload of type ovrInvitePanelResultInfoHandle. Extract the payload from the message handle with ovr_Message_GetInvitePanelResultInfo().
ovrRequest ovr_GroupPresence_LaunchMultiplayerErrorDialog
Launch an error dialog with predefined messages for common multiplayer errors.A message with type ovrMessage_GroupPresence_LaunchMultiplayerErrorDialog 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!
ovrRequest ovr_GroupPresence_LaunchRejoinDialog
( const char * lobby_session_id,
const char * match_session_id,
const char * destination_api_name )
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.
A message with type ovrMessage_GroupPresence_LaunchRejoinDialog will be generated in response.First call ovr_Message_IsError() to check if an error occurred.If no error occurred, the message will contain a payload of type ovrRejoinDialogResultHandle. Extract the payload from the message handle with ovr_Message_GetRejoinDialogResult().
ovrRequest ovr_GroupPresence_LaunchRosterPanel
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.A message with type ovrMessage_GroupPresence_LaunchRosterPanel 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!
ovrRequest ovr_GroupPresence_SendInvites
( ovrID * userIDs,
unsigned int userIDLength )
Send application invites to the passed in userIDs.
Parameters
userIDs
Defines a list of user ids to get entries for.
userIDLength
The number of user IDs provided.
A message with type ovrMessage_GroupPresence_SendInvites will be generated in response.First call ovr_Message_IsError() to check if an error occurred.If no error occurred, the message will contain a payload of type ovrSendInvitesResultHandle. Extract the payload from the message handle with ovr_Message_GetSendInvitesResult().
ovrRequest ovr_GroupPresence_Set
( ovrGroupPresenceOptionsHandle groupPresenceOptions )
Set group presence for running appA message with type 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!
ovrRequest ovr_GroupPresence_SetDeeplinkMessageOverride
( const char * deeplink_message )
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.
A message with type ovrMessage_GroupPresence_SetDeeplinkMessageOverride 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!
ovrRequest ovr_GroupPresence_SetDestination
( const char * api_name )
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.
A message with type ovrMessage_GroupPresence_SetDestination 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!
ovrRequest ovr_GroupPresence_SetIsJoinable
( bool is_joinable )
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.
A message with type ovrMessage_GroupPresence_SetIsJoinable 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!
ovrRequest ovr_GroupPresence_SetLobbySession
( const char * id )
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.
A message with type ovrMessage_GroupPresence_SetLobbySession 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!
ovrRequest ovr_GroupPresence_SetMatchSession
( const char * 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.
A message with type ovrMessage_GroupPresence_SetMatchSession 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!