Source code

Revision control

Copy as Markdown

Other Tools

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/.
*
* The origin of this IDL file is
*
* Copyright:
* To the extent possible under law, the editors have waived all copyright and
* related or neighboring rights to this work.
*/
[Exposed=(Window,Worker),
Func="mozilla::dom::Notification::PrefEnabled"]
interface Notification : EventTarget {
[Throws]
constructor(DOMString title, optional NotificationOptions options = {});
[GetterThrows]
static readonly attribute NotificationPermission permission;
[NewObject, Func="mozilla::dom::Notification::RequestPermissionEnabledForScope"]
static Promise<NotificationPermission> requestPermission(optional NotificationPermissionCallback permissionCallback);
[NewObject, Func="mozilla::dom::Notification::IsGetEnabled"]
static Promise<sequence<Notification>> get(optional GetNotificationOptions filter = {});
attribute EventHandler onclick;
attribute EventHandler onshow;
attribute EventHandler onerror;
attribute EventHandler onclose;
[Pure]
readonly attribute DOMString title;
[Pure]
readonly attribute NotificationDirection dir;
[Pure]
readonly attribute DOMString? lang;
[Pure]
readonly attribute DOMString? body;
[Constant]
readonly attribute DOMString? tag;
[Pure]
readonly attribute DOMString? icon;
[Constant, Pref="dom.webnotifications.requireinteraction.enabled"]
readonly attribute boolean requireInteraction;
[Constant, Pref="dom.webnotifications.silent.enabled"]
readonly attribute boolean silent;
[Cached, Frozen, Pure, Pref="dom.webnotifications.vibrate.enabled"]
readonly attribute sequence<unsigned long> vibrate;
[Constant]
readonly attribute any data;
void close();
};
typedef (unsigned long or sequence<unsigned long>) VibratePattern;
dictionary NotificationOptions {
NotificationDirection dir = "auto";
DOMString lang = "";
DOMString body = "";
DOMString tag = "";
DOMString icon = "";
boolean requireInteraction = false;
boolean silent = false;
VibratePattern vibrate;
any data = null;
NotificationBehavior mozbehavior = {};
};
dictionary GetNotificationOptions {
DOMString tag = "";
};
[GenerateToJSON]
dictionary NotificationBehavior {
boolean noscreen = false;
boolean noclear = false;
boolean showOnlyOnce = false;
DOMString soundFile = "";
sequence<unsigned long> vibrationPattern;
};
enum NotificationPermission {
"default",
"denied",
"granted"
};
callback NotificationPermissionCallback = void (NotificationPermission permission);
enum NotificationDirection {
"auto",
"ltr",
"rtl"
};