chrome.notifications

Beschreibung

Mit der chrome.notifications API können Sie umfassende 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 Maske für App-Symbole 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 Bilds 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 in kleinerer Schrift.

  • eventTime

    Nummer optional

    Ein Zeitstempel für die Benachrichtigung in Millisekunden seit der Epoche (z.B. Date.now() + n).

  • iconUrl

    String optional

    Eine URL zum Avatar, App-Symbol oder Thumbnail des Absenders 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 Image ist für Mac OS X-Nutzer nicht sichtbar.

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

  • isClickable

    Boolescher Wert optional

    Seit Chrome 67 eingestellt

    Dieser UI-Hinweis wird ab Chrome 67 ignoriert

  • items

    NotificationItem[] optional

    Elemente für Benachrichtigungen über mehrere Elemente. Nutzer von Mac OS X sehen nur das erste Element.

  • Nachricht

    String optional

    Inhalt der Hauptbenachrichtigung.

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

  • priorität

    Nummer optional

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

    Nummer optional

    Der aktuelle Fortschritt liegt zwischen 0 und 100.

  • requireInteraction

    Boolescher Wert optional

    Chrome 50 oder höher

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

  • Lautlos

    Boolescher Wert optional

    Chrome 70 oder höher

    Zeigt an, dass beim Anzeigen der Benachrichtigung weder Töne zu hören noch Vibrationen zu hören sein sollten. Die Standardeinstellung ist „false“.

  • Titel

    String optional

    Titel der Benachrichtigung (z. B. Absendername bei E-Mail)

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

  • Typ

    TemplateType optional

    Welche Art von Benachrichtigung angezeigt werden soll. Erforderlich für die Methode notifications.create.

PermissionLevel

Enum

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

"denied"
Gibt an, dass der Nutzer ausgewählt hat, dass Benachrichtigungen der App oder Erweiterung nicht angezeigt werden.

TemplateType

Enum

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

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

Versprechen 
chrome.notifications.clear(
  notificationId: string,
  callback?: function,
)

Löscht die angegebene Benachrichtigung.

Parameters

  • 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: 

    (wasCleared: boolean)=>void

    • wasCleared

      boolean

Rückgaben

  • Promise<boolean>

    Chrome 116 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

create()

Versprechen 
chrome.notifications.create(
  notificationId?: string,
  options: NotificationOptions,
  callback?: function,
)

Erstellt und zeigt eine Benachrichtigung an.

Parameters

  • notificationId

    String optional

    ID der Benachrichtigung. Wenn die Richtlinie nicht konfiguriert oder leer ist, wird automatisch eine ID generiert. Wenn sie mit einer vorhandenen Benachrichtigung übereinstimmt, löscht diese Methode diese Benachrichtigung zuerst, 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: 

    (notificationId: string)=>void

    • notificationId

      String

Rückgaben

  • Versprechen<string>

    Chrome 116 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

getAll()

Versprechen 
chrome.notifications.getAll(
  callback?: function,
)

Ruft alle Benachrichtigungen dieser App oder Erweiterung ab.

Parameters

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (notifications: object)=>void

    • Benachrichtigungen

      Objekt

Rückgaben

  • Promise<object>

    Chrome 116 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

getPermissionLevel()

Versprechen 
chrome.notifications.getPermissionLevel(
  callback?: function,
)

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

Parameters

Rückgaben

  • Promise<PermissionLevel>

    Chrome 116 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

update()

Versprechen 
chrome.notifications.update(
  notificationId: string,
  options: NotificationOptions,
  callback?: function,
)

Aktualisiert eine vorhandene Benachrichtigung.

Parameters

  • 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: 

    (wasUpdated: boolean)=>void

    • wasUpdated

      boolean

Rückgaben

  • Promise<boolean>

    Chrome 116 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

Veranstaltungen

onButtonClicked

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

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

Parameters

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (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.

Parameters

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (notificationId: string)=>void

    • notificationId

      String

onClosed

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

Die Benachrichtigung wurde vom System oder durch eine Nutzeraktion geschlossen.

Parameters

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

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

    • notificationId

      String

    • byUser

      boolean

onPermissionLevelChanged

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

Der Nutzer ändert die Berechtigungsstufe. Ab Chrome 47 gibt es nur noch die Benutzeroberfläche von ChromeOS, über die dieses Ereignis ausgelöst wird.

Parameters

onShowSettings

Seit Chrome 65 eingestellt
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 gibt es nur noch die Benutzeroberfläche von ChromeOS, über die dieses Ereignis ausgelöst wird. Mit Chrome 65 wurde auch diese Benutzeroberfläche aus ChromeOS entfernt.

Parameters

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    ()=>void