Type Alias WebNotificationsAPI

type WebNotificationsAPI = {
    clearCache: typeof clearCache;
    deleteNotification: typeof deleteNotification;
    deleteNotifications: typeof deleteNotifications;
    getNotification: typeof getNotification;
    getNotifications: typeof getNotifications;
    patchNotification: typeof patchNotification;
    patchNotifications: typeof patchNotifications;
}
Index

Properties

clearCache deleteNotification deleteNotifications getNotification getNotifications patchNotification patchNotifications

Properties

clearCache: typeof clearCache

Clears the cache for web-notifications api requests.

deleteNotification: typeof deleteNotification

Delete a notification.

The id of the notification to delete.

DeleteNotificationHttpError

deleteNotifications: typeof deleteNotifications

Delete all notifications.

DeleteNotificationsHttpError

getNotification: typeof getNotification

Retrieve a single notification by Id.

The id of the notification to retrieve.

GetNotificationHttpError

getNotifications: typeof getNotifications

Retrieve notifications matching the query.

getNotifications(
  {
    resourceType: "app,space"
  }
)

an object with query parameters

GetNotificationsHttpError

patchNotification: typeof patchNotification

Patch a notification.

The id of the notification to update.

Param: body

an object with the body content

PatchNotificationHttpError

patchNotifications: typeof patchNotifications

Patch all notifications.

Param: body

an object with the body content

PatchNotificationsHttpError

Settings

Member Visibility

On This Page

Properties