chrome.notifications

Beschreibung

Mit der chrome.notifications API können Sie mithilfe von Vorlagen umfangreiche Benachrichtigungen erstellen und Nutzern in der Taskleiste anzeigen lassen.

Berechtigungen

notifications

Typen

NotificationBitmap

NotificationButton

Attribute

  • iconUrl

    String optional

    <ph type="x-smartling-placeholder"></ph> Eingestellt seit Chrome 59

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

  • Titel

    String

NotificationItem

Attribute

  • Nachricht

    String

    Weitere Details zu diesem Artikel.

  • Titel

    String

    Titel eines Elements einer Listenbenachrichtigung.

NotificationOptions

Attribute

  • appIconMaskUrl

    String optional

    <ph type="x-smartling-placeholder"></ph> Eingestellt seit Chrome 59

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

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

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

  • Schaltflächen

    NotificationButton[] optional

    Text und Symbole für bis zu zwei Aktionsschaltflächen für Benachrichtigungen.

  • contextMessage

    String optional

    Alternativer Benachrichtigungsinhalt mit geringerer Schriftart.

  • eventTime

    Zahl optional

    Ein Zeitstempel für die Benachrichtigung in Millisekunden nach 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

    <ph type="x-smartling-placeholder"></ph> Eingestellt seit Chrome 59

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

    Eine URL zur Miniaturansicht für Benachrichtigungen zu Bildern. Für URLs gelten dieselben Einschränkungen wie für iconUrl.

  • isClickable

    Boolescher Wert optional

    <ph type="x-smartling-placeholder"></ph> Eingestellt seit Chrome 67

    Dieser UI-Hinweis wird ab Chrome 67 ignoriert.

  • Artikel

    NotificationItem[] optional

    Artikel für Benachrichtigungen zu mehreren Artikeln. Nutzer von Mac OS X sehen nur den ersten Eintrag.

  • Nachricht

    String optional

    Inhalt der Hauptbenachrichtigung.

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

  • priorität

    Zahl optional

    Die Priorität reicht von -2 bis 2. -2 ist die niedrigste Priorität. 2 ist der höchste Wert. Null ist die Standardeinstellung. 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

    Zahl optional

    Der aktuelle Fortschritt liegt zwischen 0 und 100.

  • requireInteraction

    Boolescher Wert optional

    Chrome 50 und höher

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

  • Lautlos

    Boolescher Wert optional

    Chrome 70 oder höher

    Gibt an, dass keine Töne oder Vibrationen ausgelöst werden sollen, während die Benachrichtigung angezeigt wird. Der Standardwert ist „false“.

  • Titel

    String optional

    Der Titel der Benachrichtigung (z.B. der Name des Absenders für die E-Mail).

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

  • Typ

    TemplateType optional

    Die Art der anzuzeigenden Benachrichtigung. Erforderlich für die Methode notifications.create.

PermissionLevel

Enum

"granted"
Gibt an, dass der Nutzer ausgewählt hat, dass Benachrichtigungen von der App oder Erweiterung angezeigt werden. Dies ist die Standardeinstellung bei der Installation.

"denied"
Gibt an, dass der Nutzer sich dafür entschieden hat, keine Benachrichtigungen von der App oder Erweiterung anzuzeigen.

TemplateType

Enum

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

"image"
Enthält ein Symbol, einen Titel, eine Nachricht, eine maximierte 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 von 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()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.notifications.clear(
  notificationId: string,
  callback?: function,
)

Löscht die angegebene Benachrichtigung.

Parameter

  • notificationId

    String

    Die ID der zu löschenden Benachrichtigung. Dies wird von der Methode notifications.create zurückgegeben.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (wasCleared: boolean) => void

    • wasCleared

      boolean

Gibt Folgendes zurück:

  • Promise&lt;boolean&gt;

    Chrome 116 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

create()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.notifications.create(
  notificationId?: string,
  options: NotificationOptions,
  callback?: function,
)

Erstellt eine Benachrichtigung und zeigt sie an.

Parameter

  • notificationId

    String optional

    ID der Benachrichtigung. Wenn nichts festgelegt oder leer ist, wird automatisch eine ID generiert. Wenn sie mit einer vorhandenen Benachrichtigung übereinstimmt, löscht diese Methode diese Benachrichtigung zunächst, bevor mit dem Erstellungsvorgang fortgefahren wird. Die ID darf nicht länger als 500 Zeichen sein.

    Der Parameter notificationId ist vor Chrome 42 erforderlich.

  • Inhalt der Benachrichtigung.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (notificationId: string) => void

    • notificationId

      String

Gibt Folgendes zurück:

  • Promise&lt;string&gt;

    Chrome 116 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

getAll()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.notifications.getAll(
  callback?: function,
)

Ruft alle Benachrichtigungen dieser App oder Erweiterung ab.

Parameter

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (notifications: object) => void

    • Benachrichtigungen

      Objekt

Gibt Folgendes zurück:

  • Promise&lt;object&gt;

    Chrome 116 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

getPermissionLevel()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.notifications.getPermissionLevel(
  callback?: function,
)

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

Parameter

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (level: PermissionLevel) => void

Gibt Folgendes zurück:

  • Promise&lt;PermissionLevel&gt;

    Chrome 116 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

update()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.notifications.update(
  notificationId: string,
  options: NotificationOptions,
  callback?: function,
)

Aktualisiert eine bestehende Benachrichtigung.

Parameter

  • notificationId

    String

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

  • Inhalt der Benachrichtigung, auf die aktualisiert werden soll.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (wasUpdated: boolean) => void

    • wasUpdated

      boolean

Gibt Folgendes zurück:

  • Promise&lt;boolean&gt;

    Chrome 116 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

Ereignisse

onButtonClicked

chrome.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: <ph type="x-smartling-placeholder"></ph>

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

    • notificationId

      String

    • buttonIndex

      Zahl

onClicked

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

Der Nutzer hat in einem Bereich der Benachrichtigung geklickt, der sich nicht auf eine Schaltfläche bezieht.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (notificationId: string) => void

    • notificationId

      String

onClosed

chrome.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: <ph type="x-smartling-placeholder"></ph>

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

    • notificationId

      String

    • byUser

      boolean

onPermissionLevelChanged

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

Der Nutzer ändert die Berechtigungsstufe. Ab Chrome 47 hat nur ChromeOS eine Benutzeroberfläche, die dieses Ereignis auslöst.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (level: PermissionLevel) => void

onShowSettings

<ph type="x-smartling-placeholder"></ph> Eingestellt seit Chrome 65
chrome.notifications.onShowSettings.addListener(
  callback: function,
)

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

Der Nutzer hat auf einen Link zu den Benachrichtigungseinstellungen der App geklickt. Ab Chrome 47 hat nur ChromeOS eine Benutzeroberfläche, die dieses Ereignis auslöst. Mit Chrome 65 wird diese UI auch aus ChromeOS entfernt.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    () => void