developers
Login

This website uses cookies to improve our services and deliver relevant ads.
By interacting with this site, you agree to this use. For more information, see our Cookies Policy

Platform 1.28 Reference Guide

OVR_Requests_Notification.h File Reference

Functions

ovrRequest
ovrRequest
ovrRequest

Detailed Description

*** Notifications Overview: Notifications are a way for the Oculus platform to push timely updates to your application. These are typically time-sensitive items and try to be prolific. In addition to your application, they usually present themselves in the 2D/3D Stores as well as Universal Menu.
*** Read Status: Notifications will currently show up in these areas until they either expire or they're marked as read. If you mark a notification as read, it'll be removed from all surfaces.

Function Documentation

ovrRequest ovr_Notification_GetNextRoomInviteNotificationArrayPage ( ovrRoomInviteNotificationArrayHandle handle )
Get the next page of entries
A message with type ovrMessage_Notification_GetNextRoomInviteNotificationArrayPage 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 ovrRoomInviteNotificationArrayHandle. Extract the payload from the message handle with ovr_Message_GetRoomInviteNotificationArray().
ovrRequest ovr_Notification_GetRoomInvites ( )
Retrieve a list of all pending room invites for your application (for example, notifications that may have been sent before the user launched your game). You can also get push notifications with ovrNotification_Room_InviteReceived.
A message with type ovrMessage_Notification_GetRoomInvites 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 ovrRoomInviteNotificationArrayHandle. Extract the payload from the message handle with ovr_Message_GetRoomInviteNotificationArray().
ovrRequest ovr_Notification_MarkAsRead ( ovrID notificationID )
Mark a notification as read. This causes it to disappear from the Universal Menu, the Oculus App, Oculus Home, and in-app retrieval.
A message with type ovrMessage_Notification_MarkAsRead will be generated in response.
First call ovr_Message_IsError() to check if an error occurred.
This response has no payload. If no error occured, the request was successful. Yay!
1
2
3
4
5
6
7
8
9
10
22
31
32
44
45
54
55
56
// This file was @generated with LibOVRPlatform/codegen/main. Do not modify it!

#ifndef OVR_REQUESTS_NOTIFICATION_H
#define OVR_REQUESTS_NOTIFICATION_H

#include "OVR_Types.h"
#include "OVR_Platform_Defs.h"

#include "OVR_RoomInviteNotificationArray.h"


OVRP_PUBLIC_FUNCTION(ovrRequest) ovr_Notification_GetNextRoomInviteNotificationArrayPage(ovrRoomInviteNotificationArrayHandle handle);

OVRP_PUBLIC_FUNCTION(ovrRequest) ovr_Notification_GetRoomInvites();

OVRP_PUBLIC_FUNCTION(ovrRequest) ovr_Notification_MarkAsRead(ovrID notificationID);

#endif
The documentation for this file was generated from the following file: OVR_Requests_Notification.h