browser.notifications

Beschreibung

Mit der chrome.notifications API kannst du Rich-Benachrichtigungen mithilfe von Vorlagen erstellen und diese Benachrichtigungen Nutzern in der Taskleiste anzeigen lassen.

Berechtigungen

notifications

Typen

NotificationBitmap

NotificationButton

Attribute

  • iconUrl

    String optional

    Seit Chrome 59 eingestellt

    Schaltflächensymbole sind für Mac OS X-Nutzer nicht sichtbar.

  • Titel

    String

NotificationItem

Attribute

  • Nachricht

    String

    Zusätzliche Details zu diesem Artikel.

  • Titel

    String

    Titel eines Elements einer Listenbenachrichtigung.

NotificationOptions

Attribute

  • appIconMaskUrl

    String optional

    Seit Chrome 59 eingestellt

    Die App-Symbolmaske ist für Mac OS X-Nutzer nicht sichtbar.

    Eine URL zur App-Symbolmaske. Für URLs gelten dieselben Einschränkungen wie für iconUrl.

    Die Maske des App-Symbols sollte sich im Alphakanal befinden, da nur der Alphakanal des Bildes berücksichtigt wird.

  • Buttons

    NotificationButton[] optional

    Text und Symbole für bis zu zwei Aktionsbuttons für Benachrichtigungen.

  • contextMessage

    String optional

    Wechseln Sie den Inhalt der Benachrichtigung mit einer Schriftart mit geringerer Stärke ab.

  • eventTime

    number optional

    Ein Zeitstempel, der mit der Benachrichtigung verknüpft ist, in Millisekunden seit der Epoche (z.B. Date.now() + n).

  • iconUrl

    String optional

    Eine URL zum Avatar des Absenders, zum App-Symbol oder zu einer Miniaturansicht für Bildbenachrichtigungen.

    URLs können eine Daten-URL, eine Blob-URL oder eine URL sein, die sich auf eine Ressource in der CRX-Datei dieser Erweiterung bezieht

    **Hinweis:**Dieser Wert ist für die Methode notifications.create() erforderlich.

  • imageUrl

    String optional

    Seit Chrome 59 eingestellt

    Das Bild ist für Mac OS X-Nutzer nicht sichtbar.

    Eine URL zum Vorschaubild für Benachrichtigungen vom Typ „Bild“. Für URLs gelten dieselben Einschränkungen wie für iconUrl.

  • isClickable

    Boolesch optional

    Seit Chrome 67 verworfen

    Dieser UI-Hinweis wird ab Chrome 67 ignoriert.

  • Elemente

    NotificationItem[] optional

    Elemente für Benachrichtigungen zu mehreren Elementen. Nutzer unter Mac OS X sehen nur das erste Element.

  • Nachricht

    String optional

    Hauptinhalt der Benachrichtigung.

    **Hinweis:**Dieser Wert ist für die Methode notifications.create() erforderlich.

  • priority

    number optional

    Die Priorität reicht von -2 bis 2. -2 ist die niedrigste Priorität. 2 ist die höchste. Der Standardwert ist null. Auf Plattformen, die kein Benachrichtigungscenter unterstützen (Windows, Linux und Mac), führen -2 und -1 zu einem Fehler, da Benachrichtigungen mit diesen Prioritäten überhaupt nicht angezeigt werden.

  • Fortschritt

    number optional

    Der aktuelle Fortschritt liegt im Bereich von 0 bis 100.

  • requireInteraction

    Boolesch optional

    Chrome 50 und höher browser.* seit Chrome 148

    Gibt an, dass die Benachrichtigung auf dem Bildschirm sichtbar bleiben soll, bis der Nutzer sie aktiviert oder schließt. Die Standardeinstellung ist „false“.

  • Lautlos

    Boolesch optional

    Chrome 70 und höher browser.* seit Chrome 148

    Gibt an, dass keine Töne oder Vibrationen ausgegeben werden sollen, wenn die Benachrichtigung angezeigt wird. Die Standardeinstellung ist „false“.

  • Titel

    String optional

    Titel der Benachrichtigung (z.B. Absendername für E‑Mail).

    **Hinweis:**Dieser Wert ist für die Methode notifications.create() erforderlich.

  • Typ

    TemplateType optional

    Der Typ der Benachrichtigung, die angezeigt werden soll. Erforderlich für die Methode notifications.create.

PermissionLevel

Enum

granted
Gibt an, dass der Nutzer Benachrichtigungen von der App oder Erweiterung zulässt. Dies ist die Standardeinstellung bei der Installation.

"denied"
Gibt an, dass der Nutzer festgelegt hat, dass keine Benachrichtigungen von der App oder Erweiterung angezeigt werden sollen.

TemplateType

Enum

"basic"
Enthält ein Symbol, einen Titel, eine Nachricht, eine erweiterte Nachricht und bis zu zwei Schaltflächen.

"image"
Enthält ein Symbol, einen Titel, eine Nachricht, eine erweiterte Nachricht, ein Bild und bis zu zwei Schaltflächen.

"list"
Enthält ein Symbol, einen Titel, eine Nachricht, Elemente und bis zu zwei Schaltflächen. Nutzer unter Mac OS X sehen nur das erste Element.

"progress"
Enthält ein Symbol, einen Titel, eine Nachricht, einen Fortschritt und bis zu zwei Schaltflächen.

Methoden

clear()

browser.notifications.clear(
  notificationId: string,
): Promise<boolean>

Löscht die angegebene Benachrichtigung.

Parameter

  • notificationId

    String

    Die ID der Benachrichtigung, die gelöscht werden soll. Dies wird von der Methode notifications.create zurückgegeben.

Ausgabe

  • Promise<boolean>

    Chrome 116 und höher browser.* seit Chrome 148

    Gibt ein Promise zurück, das angibt, ob eine übereinstimmende Benachrichtigung vorhanden war.

create()

browser.notifications.create(
  notificationId?: string,
  options: NotificationOptions,
): Promise<string>

Erstellt eine Benachrichtigung und zeigt sie an.

Parameter

  • notificationId

    String optional

    ID der Benachrichtigung. Wenn nicht festgelegt oder leer, wird automatisch eine ID generiert. Wenn sie mit einer vorhandenen Benachrichtigung übereinstimmt, wird diese Benachrichtigung zuerst gelöscht, bevor der Erstellungsvorgang fortgesetzt wird. Die Kennung darf nicht länger als 500 Zeichen sein.

    Der Parameter notificationId ist vor Chrome 42 erforderlich.

  • Inhalt der Benachrichtigung.

Ausgabe

  • Promise<string>

    Chrome 116 und höher browser.* seit Chrome 148

    Gibt ein Promise zurück, das mit der Benachrichtigungs-ID (entweder angegeben oder generiert) aufgelöst wird, die die erstellte Benachrichtigung darstellt.

getAll()

browser.notifications.getAll(): Promise<object>

Ruft alle Benachrichtigungen dieser App oder Erweiterung ab.

Ausgabe

  • Promise<object>

    Chrome 116 und höher browser.* seit Chrome 148

    Gibt ein Promise zurück, das mit der Gruppe von notification_ids aufgelöst wird, die sich derzeit im System befinden.

getPermissionLevel()

browser.notifications.getPermissionLevel(): Promise<PermissionLevel>

Ruft ab, ob der Nutzer Benachrichtigungen von dieser App oder Erweiterung aktiviert hat.

Ausgabe

  • Promise<PermissionLevel>

    Chrome 116 und höher browser.* seit Chrome 148

    Gibt ein Promise zurück, das mit der aktuellen Berechtigungsstufe aufgelöst wird.

update()

browser.notifications.update(
  notificationId: string,
  options: NotificationOptions,
): Promise<boolean>

Aktualisiert eine vorhandene Benachrichtigung.

Parameter

  • notificationId

    String

    Die ID der zu aktualisierenden Benachrichtigung. Dies wird von der Methode notifications.create zurückgegeben.

  • Inhalt der Benachrichtigung, die aktualisiert werden soll.

Ausgabe

  • Promise<boolean>

    Chrome 116 und höher browser.* seit Chrome 148

    Gibt ein Promise zurück, das angibt, ob eine übereinstimmende Benachrichtigung vorhanden war.

Ereignisse

onButtonClicked

browser.notifications.onButtonClicked.addListener(
  callback: function,
)

Der Nutzer hat eine Schaltfläche in der Benachrichtigung gedrückt.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (notificationId: string, buttonIndex: number) => void

    • notificationId

      String

    • buttonIndex

      Zahl

onClicked

browser.notifications.onClicked.addListener(
  callback: function,
)

Der Nutzer hat auf einen Bereich der Benachrichtigung geklickt, der keine Schaltfläche ist.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (notificationId: string) => void

    • notificationId

      String

onClosed

browser.notifications.onClosed.addListener(
  callback: function,
)

Die Benachrichtigung wurde entweder vom System oder durch eine Nutzeraktion geschlossen.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (notificationId: string, byUser: boolean) => void

    • notificationId

      String

    • byUser

      boolean

onPermissionLevelChanged

browser.notifications.onPermissionLevelChanged.addListener(
  callback: function,
)

Der Nutzer ändert die Berechtigungsstufe. Seit Chrome 47 gibt es nur unter ChromeOS eine Benutzeroberfläche, die dieses Ereignis auslöst.

Parameter

onShowSettings

Seit Chrome 65 verworfen
browser.notifications.onShowSettings.addListener(
  callback: function,
)

Die Schaltfläche für benutzerdefinierte Benachrichtigungseinstellungen wird nicht mehr unterstützt.

Der Nutzer hat auf einen Link für die Benachrichtigungseinstellungen der App geklickt. Seit Chrome 47 gibt es nur unter ChromeOS eine Benutzeroberfläche, die dieses Ereignis auslöst. Seit Chrome 65 wurde diese Benutzeroberfläche auch aus ChromeOS entfernt.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    () => void