notifications.NotificationOptions
Dieser Typ enthält alle Daten, die benötigt werden, um:
- mit
notifications.create()eine Benachrichtigung zu erstellen, - mit
notifications.update()eine bestehende Benachrichtigung zu aktualisieren.
Typ
Werte dieses Typs sind Objekte. Sie enthalten die unten aufgeführten Eigenschaften.
Die ersten drei Eigenschaften – type, title und message – sind bei notifications.create() erforderlich, bei notifications.update() jedoch optional. Firefox unterstützt derzeit nur die Eigenschaften type, title, message und iconUrl. Der einzige unterstützte Wert für type ist 'basic'.
type-
notifications.TemplateType. Der gewünschte Benachrichtigungstyp. Je nach Ihrer Auswahl sind bestimmte andere Eigenschaften entweder erforderlich oder nicht zulässig. message-
string. Der Hauptinhalt der Benachrichtigung. title-
string. Der Titel der Benachrichtigung. iconUrlOptional-
string. Eine URL, die auf ein Symbol verweist, das in der Benachrichtigung angezeigt werden soll. Die URL kann eine Data-URL, eine Blob-URL, eine HTTP- oder HTTPS-URL oder die relative URL einer Datei innerhalb der Erweiterung sein. Wenn Sie ein SVG-Bild verwenden, stellen Sie sicher, dass es Attribute für Höhe und Breite enthält, beispielsweise<svg width="96" height="96"…. Andernfalls wird das Bild möglicherweise nicht angezeigt. contextMessageOptional-
string. Zusätzlicher Inhalt, der angezeigt werden soll. priorityOptional-
number. Die Priorität der Benachrichtigung: Sie kann 0, 1 oder 2 sein. Wenn die Eigenschaft weggelassen wird, ist der Standardwert 0. eventTimeOptional-
number. Ein Zeitstempel für die Benachrichtigung in Millisekunden seit der Unix-Epoche. -
arrayvonbutton. Ein Array mit bis zu 2 Schaltflächen, die in der Benachrichtigung angezeigt werden sollen. Mitnotifications.onButtonClickedkönnen Sie auf Klicks auf die Schaltflächen reagieren. Jede Schaltfläche wird als Objekt mit den folgenden Eigenschaften angegeben:title-
string. Titel der Schaltfläche. iconUrlOptional-
string. URL, die auf ein Symbol für die Schaltfläche verweist.
imageUrl-
string. Eine URL, die auf ein Bild verweist, das in der Benachrichtigung verwendet werden soll. Die URL kann eine Data-URL, eine Blob-URL oder die relative URL einer Datei innerhalb der Erweiterung sein. Wenn Sie ein SVG-Bild verwenden, stellen Sie sicher, dass es Attribute für Höhe und Breite enthält, beispielsweise<svg width="96" height="96"…. Andernfalls wird das Bild möglicherweise nicht angezeigt.Diese Eigenschaft ist nur zulässig, wenn
typeden Wert"image"hat. In diesem Fall ist sie erforderlich, wennNotificationOptionsinnotifications.create()verwendet wird, und optional, wenn es innotifications.update()verwendet wird. items-
arrayvonitem. Ein Array von Einträgen, die in der Benachrichtigung angezeigt werden sollen. Abhängig von den Einstellungen des Benachrichtigungssystems des Betriebssystems werden möglicherweise nicht alle angegebenen Einträge angezeigt. Jeder Eintrag wird als Objekt mit den folgenden Eigenschaften angegeben:title-
string. Titel, der im Eintrag angezeigt werden soll. message-
string. Nachricht, die im Eintrag angezeigt werden soll.
Diese Eigenschaft ist nur zulässig, wenn
typeden Wert"list"hat. In diesem Fall ist sie erforderlich, wennNotificationOptionsinnotifications.create()verwendet wird, und optional, wenn es innotifications.update()verwendet wird. progress-
integer. Eine Ganzzahl zwischen 0 und 100, mit der der aktuelle Fortschritt in einer Fortschrittsanzeige dargestellt wird.Diese Eigenschaft ist nur zulässig, wenn
typeden Wert"progress"hat. In diesem Fall ist sie erforderlich, wennNotificationOptionsinnotifications.create()verwendet wird, und optional, wenn es innotifications.update()verwendet wird.
Beachten Sie, dass appIconMaskUrl und isClickable nicht unterstützt werden.
Browser-Kompatibilität
Hinweis:
Diese API basiert auf der Chromium-API chrome.notifications.