notifications.create()

Erstellt und zeigt eine Benachrichtigung an.

Übergeben Sie eine notifications.NotificationOptions, um den Inhalt und das Verhalten der Benachrichtigung zu definieren.

Sie können optional eine ID für die Benachrichtigung angeben. Wenn Sie die ID weglassen, wird eine ID generiert. Sie können die ID verwenden, um die Benachrichtigung mit update oder clear zu aktualisieren oder zu entfernen.

Dies ist eine asynchrone Funktion, die ein Promise zurückgibt.

Warnung: Wenn Sie notifications.create() mehrmals in schneller Folge aufrufen, kann es passieren, dass Firefox überhaupt keine Benachrichtigung anzeigt.

Syntax

let creating = browser.notifications.create(
  id,                   // optional string
  options               // NotificationOptions
)

Parameter

id Optional: string. Diese wird verwendet, um auf diese Benachrichtigung in notifications.update(), notifications.clear() und Ereignis-Listenern zu verweisen. Wenn Sie dieses Argument weglassen oder einen leeren String übergeben, wird eine neue ID für diese Benachrichtigung generiert. Wenn die von Ihnen angegebene ID mit der ID einer bestehenden Benachrichtigung dieser Erweiterung übereinstimmt, wird die andere Benachrichtigung entfernt.
options: notifications.NotificationOptions. Definiert den Inhalt und das Verhalten der Benachrichtigung.

Rückgabewert

Ein Promise, das erfüllt wird, wenn die Benachrichtigung erstellt wurde und der Anzeigevorgang gestartet hat, was vor der tatsächlichen Anzeige der Benachrichtigung für den Benutzer erfolgt. Es wird mit einem String erfüllt, der die ID der Benachrichtigung darstellt.

Beispiele

Dieses Beispiel zeigt regelmäßig eine Benachrichtigung an, verwendet dabei alarm. Das Klicken auf die Browser-Aktion schließt die Benachrichtigung. Sie benötigen die "alarms" Berechtigung, um Alarme zu erstellen (sowie die "notifications"-Berechtigung, um Benachrichtigungen zu erstellen).

let cakeNotification = "cake-notification";

/*

CAKE_INTERVAL is set to 6 seconds in this example.
Such a short period is chosen to make the extension's behavior
more obvious, but this is not recommended in real life.
Note that in Chrome, alarms cannot be set for less
than a minute.

*/
let CAKE_INTERVAL = 0.1;

browser.alarms.create("", { periodInMinutes: CAKE_INTERVAL });

browser.alarms.onAlarm.addListener((alarm) => {
  browser.notifications.create(cakeNotification, {
    type: "basic",
    iconUrl: browser.runtime.getURL("icons/cake-96.png"),
    title: "Time for cake!",
    message: "Something something cake",
  });
});

browser.browserAction.onClicked.addListener(() => {
  const clearing = browser.notifications.clear(cakeNotification);
  clearing.then(() => {
    console.log("cleared");
  });
});

Beispielerweiterungen

Browser-Kompatibilität

Hinweis: Diese API basiert auf Chromiums chrome.notifications API.