Clear
()
|
Clear group presence for running app
Signature
static Request Oculus.Platform.GroupPresence.Clear() Returns Request |
GetInvitableUsers
(
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.
Signature
static Request<Models.UserList> Oculus.Platform.GroupPresence.GetInvitableUsers(InviteOptions options) Parameters options: InviteOptionsReturns Request< Models.UserList > |
GetNextApplicationInviteListPage
(
list
)
|
Signature
static Request<Models.ApplicationInviteList> Oculus.Platform.GroupPresence.GetNextApplicationInviteListPage(Models.ApplicationInviteList list) Parameters Returns Request< Models.ApplicationInviteList > |
GetSentInvites
()
|
Get the application invites which have been sent by the user.
Signature
static Request<Models.ApplicationInviteList> Oculus.Platform.GroupPresence.GetSentInvites() Returns Request< Models.ApplicationInviteList > |
LaunchInvitePanel
(
options
)
|
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.
Signature
static Request<Models.InvitePanelResultInfo> Oculus.Platform.GroupPresence.LaunchInvitePanel(InviteOptions options) Parameters options: InviteOptionsReturns Request< Models.InvitePanelResultInfo > |
LaunchMultiplayerErrorDialog
(
options
)
|
Launch an error dialog with predefined messages for common multiplayer errors.
Signature
static Request Oculus.Platform.GroupPresence.LaunchMultiplayerErrorDialog(MultiplayerErrorOptions options) Parameters options: MultiplayerErrorOptionsReturns Request |
LaunchRejoinDialog
(
lobby_session_id
, match_session_id
, 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.
Signature
static Request<Models.RejoinDialogResult> Oculus.Platform.GroupPresence.LaunchRejoinDialog(string lobby_session_id, string match_session_id, string destination_api_name) Parameters lobby_session_id: stringmatch_session_id: stringdestination_api_name: stringReturns Request< Models.RejoinDialogResult > |
LaunchRosterPanel
(
options
)
|
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.
Signature
static Request Oculus.Platform.GroupPresence.LaunchRosterPanel(RosterOptions options) Parameters options: RosterOptionsReturns Request |
SendInvites
(
userIDs
)
|
Send application invites to the passed in userIDs.
Signature
static Request<Models.SendInvitesResult> Oculus.Platform.GroupPresence.SendInvites(UInt64[] userIDs) Parameters userIDs: UInt64 []Returns Request< Models.SendInvitesResult > |
Set
(
groupPresenceOptions
)
|
Set group presence for running app
Signature
static Request Oculus.Platform.GroupPresence.Set(GroupPresenceOptions groupPresenceOptions) Parameters groupPresenceOptions: GroupPresenceOptionsReturns Request |
SetDeeplinkMessageOverride
(
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.
Signature
static Request Oculus.Platform.GroupPresence.SetDeeplinkMessageOverride(string deeplink_message) Parameters deeplink_message: stringReturns Request |
SetDestination
(
api_name
)
|
Replaces the user's current destination for the provided one. All other existing group presence parameters will remain the same.
Signature
static Request Oculus.Platform.GroupPresence.SetDestination(string api_name) Parameters api_name: stringReturns Request |
SetInvitationsSentNotificationCallback
(
callback
)
|
Sent when the user is finished using the invite panel to send out invitations. Contains a list of invitees.
Signature
static void Oculus.Platform.GroupPresence.SetInvitationsSentNotificationCallback(Message< Models.LaunchInvitePanelFlowResult >.Callback callback) Parameters callback: Message< Models.LaunchInvitePanelFlowResult >.CallbackReturns void |
SetIsJoinable
(
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.
Signature
static Request Oculus.Platform.GroupPresence.SetIsJoinable(bool is_joinable) Parameters is_joinable: boolReturns Request |
SetJoinIntentReceivedNotificationCallback
(
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.
Signature
static void Oculus.Platform.GroupPresence.SetJoinIntentReceivedNotificationCallback(Message< Models.GroupPresenceJoinIntent >.Callback callback) Parameters callback: Message< Models.GroupPresenceJoinIntent >.CallbackReturns void |
SetLeaveIntentReceivedNotificationCallback
(
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.
Signature
static void Oculus.Platform.GroupPresence.SetLeaveIntentReceivedNotificationCallback(Message< Models.GroupPresenceLeaveIntent >.Callback callback) Parameters callback: Message< Models.GroupPresenceLeaveIntent >.CallbackReturns void |
SetLobbySession
(
id
)
|
Replaces the user's current lobby session id for the provided one. All other existing group presence parameters will remain the same.
Signature
static Request Oculus.Platform.GroupPresence.SetLobbySession(string id) Parameters id: stringReturns Request |
SetMatchSession
(
id
)
|
Replaces the user's current match session id for the provided one. All other existing group presence parameters will remain the same.
Signature
static Request Oculus.Platform.GroupPresence.SetMatchSession(string id) Parameters id: stringReturns Request |