chrome.notifications

Beschreibung

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

Berechtigungen

notifications

Typen

NotificationBitmap

NotificationButton

Attribute

  • iconUrl

    String optional

    Seit Chrome 59 nicht mehr unterstützt

    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 List-Benachrichtigung.

NotificationOptions

Attribute

  • appIconMaskUrl

    String optional

    Seit Chrome 59 nicht mehr unterstützt

    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 App-Symbolmaske muss im Alphakanal sein, da nur der Alphakanal des Bildes berücksichtigt wird.

  • Schaltflächen

    NotificationButton[] optional

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

  • contextMessage

    String optional

    Verwenden Sie für alternativen Benachrichtigungsinhalt eine Schrift mit geringerer Stärke.

  • eventTime

    number optional

    Ein Zeitstempel, der der Benachrichtigung zugeordnet 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 relativ zu einer Ressource in der CRX-Datei dieser Erweiterung sein.

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

  • imageUrl

    String optional

    Seit Chrome 59 nicht mehr unterstützt

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

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

  • isClickable

    boolean optional

    Seit Chrome 67 eingestellt

    Dieser UI-Hinweis wird ab Chrome 67 ignoriert.

  • Elemente

    NotificationItem[] optional

    Elemente für Benachrichtigungen mit 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.

  • priorität

    number optional

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

  • Fortschritt

    number optional

    Der aktuelle Fortschritt liegt zwischen 0 und 100.

  • requireInteraction

    boolean 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. Die Standardeinstellung ist „false“.

  • Lautlos

    boolean optional

    Chrome 70 und höher

    Gibt an, dass beim Anzeigen der Benachrichtigung keine Töne oder Vibrationen ausgegeben werden sollen. Die Standardeinstellung ist „false“.

  • Titel

    String optional

    Titel der Benachrichtigung, z.B. Absendername für E‑Mails.

    **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 Benachrichtigungen von der App oder Erweiterung anzeigen lassen möchte. Dies ist die Standardeinstellung bei der Installation.

„denied“
Gibt an, dass der Nutzer keine Benachrichtigungen von der App oder Erweiterung erhalten möchte.

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 Fortschrittsbalken und bis zu zwei Schaltflächen.

Methoden

clear()

Promise 
chrome.notifications.clear(
  notificationId: string,
  callback?: function,
): Promise<boolean>

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: 

    (wasCleared: boolean) => void

    • wasCleared

      boolean

Ausgabe

  • Promise<boolean>

    Chrome 116 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

create()

Promise 
chrome.notifications.create(
  notificationId?: string,
  options: NotificationOptions,
  callback?: function,
): Promise<string>

Erstellt und zeigt eine Benachrichtigung an.

Parameter

  • notificationId

    String optional

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

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (notificationId: string) => void

    • notificationId

      String

Ausgabe

  • Promise<string>

    Chrome 116 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

getAll()

Promise 
chrome.notifications.getAll(
  callback?: function,
): Promise<object>

Ruft alle Benachrichtigungen dieser App oder Erweiterung ab.

Parameter

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (notifications: object) => void

    • Benachrichtigungen

      Objekt

Ausgabe

  • Promise<object>

    Chrome 116 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

getPermissionLevel()

Promise 
chrome.notifications.getPermissionLevel(
  callback?: function,
): Promise<PermissionLevel>

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

Parameter

Ausgabe

  • Promise<PermissionLevel>

    Chrome 116 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

update()

Promise 
chrome.notifications.update(
  notificationId: string,
  options: NotificationOptions,
  callback?: function,
): 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.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (wasUpdated: boolean) => void

    • wasUpdated

      boolean

Ausgabe

  • Promise<boolean>

    Chrome 116 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

Ereignisse

onButtonClicked

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

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

Parameter

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

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: 

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

    • notificationId

      String

    • byUser

      boolean

onPermissionLevelChanged

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

Der Nutzer ändert die Berechtigungsstufe. Ab Chrome 47 ist nur unter ChromeOS eine Benutzeroberfläche verfügbar, die dieses Ereignis auslöst.

Parameter

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 für die Benachrichtigungseinstellungen der App geklickt. Ab Chrome 47 ist nur unter ChromeOS eine Benutzeroberfläche verfügbar, die dieses Ereignis auslöst. Seit Chrome 65 ist diese Benutzeroberfläche auch aus ChromeOS entfernt.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    () => void