chrome.notifications

Description

Utilisez l'API chrome.notifications pour créer des notifications enrichies à l'aide de modèles et les afficher aux utilisateurs dans la barre d'état système.

Autorisations

notifications

Types

NotificationBitmap

NotificationButton

Propriétés

  • iconUrl

    chaîne facultative

    Obsolète depuis Chrome 59

    Les icônes des boutons ne sont pas visibles pour les utilisateurs de Mac OS X.

  • titre

    chaîne

NotificationItem

Propriétés

  • message

    chaîne

    Informations supplémentaires sur cet élément.

  • titre

    chaîne

    Titre d'un élément d'une notification de liste.

NotificationOptions

Propriétés

  • appIconMaskUrl

    chaîne facultative

    Obsolète depuis Chrome 59

    Le masque de l'icône de l'application n'est pas visible pour les utilisateurs de Mac OS X.

    URL du masque de l'icône de l'application. Les URL sont soumises aux mêmes restrictions que iconUrl.

    Le masque de l'icône de l'application doit être dans le canal alpha, car seul le canal alpha de l'image sera pris en compte.

  • boutons

    NotificationButton[] facultatif

    Texte et icônes pour un maximum de deux boutons d'action de notification.

  • contextMessage

    chaîne facultative

    Contenu de notification alternatif avec une police moins épaisse.

  • eventTime

    number facultatif

    Code temporel associé à la notification, en millisecondes depuis l'époque (par exemple, Date.now() + n).

  • iconUrl

    chaîne facultative

    URL de l'avatar de l'expéditeur, de l'icône de l'application ou d'une miniature pour les notifications d'image.

    Les URL peuvent être des URL de données, des URL blob ou des URL relatives à une ressource dans le fichier .crx de cette extension.

    **Remarque **: Cette valeur est requise pour la méthode notifications.create().

  • imageUrl

    chaîne facultative

    Obsolète depuis Chrome 59

    L'image n'est pas visible pour les utilisateurs de Mac OS X.

    URL de la miniature de l'image pour les notifications de type image. Les URL sont soumises aux mêmes restrictions que iconUrl.

  • isClickable

    booléen facultatif

    Obsolète depuis Chrome 67

    Cet indice d'interface utilisateur est ignoré à partir de Chrome 67.

  • éléments

    NotificationItem[] optional

    Éléments pour les notifications à plusieurs éléments. Les utilisateurs de Mac OS X ne voient que le premier élément.

  • message

    chaîne facultative

    Contenu principal de la notification.

    **Remarque **: Cette valeur est requise pour la méthode notifications.create().

  • priorité

    number facultatif

    La priorité est comprise entre -2 et 2. -2 : priorité la plus faible. 2 est la valeur la plus élevée. La valeur par défaut est zéro. Sur les plates-formes qui ne sont pas compatibles avec un centre de notifications (Windows, Linux et Mac), les valeurs -2 et -1 entraînent une erreur, car les notifications avec ces priorités ne s'affichent pas du tout.

  • progression

    number facultatif

    La progression actuelle est comprise entre 0 et 100.

  • requireInteraction

    booléen facultatif

    Chrome 50 et versions ultérieures

    Indique que la notification doit rester visible à l'écran jusqu'à ce que l'utilisateur l'active ou l'ignore. La valeur par défaut est "false".

  • silencieux

    booléen facultatif

    Chrome 70 et versions ultérieures

    Indique qu'aucun son ni aucune vibration ne doivent être émis lors de l'affichage de la notification. La valeur par défaut est "false".

  • titre

    chaîne facultative

    Titre de la notification (par exemple, nom de l'expéditeur pour un e-mail).

    **Remarque **: Cette valeur est requise pour la méthode notifications.create().

  • type

    TemplateType facultatif

    Type de notification à afficher. Obligatoire pour la méthode notifications.create.

PermissionLevel

Énumération

"granted"
Indique que l'utilisateur a choisi d'afficher les notifications de l'application ou de l'extension. Il s'agit du paramètre par défaut lors de l'installation.

"denied"
Indique que l'utilisateur a choisi de ne pas afficher les notifications de l'application ou de l'extension.

TemplateType

Énumération

"basic"
Contient une icône, un titre, un message, un message développé et jusqu'à deux boutons.

"image"
Contient une icône, un titre, un message, un message développé, une image et jusqu'à deux boutons.

"list"
Contient une icône, un titre, un message, des éléments et jusqu'à deux boutons. Les utilisateurs de Mac OS X ne voient que le premier élément.

"progress"
Contient une icône, un titre, un message, une barre de progression et jusqu'à deux boutons.

Méthodes

clear()

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

Efface la notification spécifiée.

Paramètres

  • notificationId

    chaîne

    ID de la notification à effacer. Cette valeur est renvoyée par la méthode notifications.create.

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    (wasCleared: boolean) => void

    • wasCleared

      booléen

Renvoie

  • Promise<boolean>

    Chrome 116 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

create()

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

Crée et affiche une notification.

Paramètres

  • notificationId

    chaîne facultative

    Identifiant de la notification. Si aucun ID n'est défini ou si le champ est vide, un ID sera généré automatiquement. Si elle correspond à une notification existante, cette méthode efface d'abord cette notification avant de procéder à l'opération de création. L'identifiant ne peut pas comporter plus de 500 caractères.

    Le paramètre notificationId est obligatoire avant Chrome 42.

  • Contenu de la notification.

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    (notificationId: string) => void

    • notificationId

      chaîne

Renvoie

  • Promise<string>

    Chrome 116 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getAll()

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

Récupère toutes les notifications de cette application ou extension.

Paramètres

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    (notifications: object) => void

    • notifications

      objet

Renvoie

  • Promise<object>

    Chrome 116 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getPermissionLevel()

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

Récupère l'état d'activation des notifications de cette application ou extension par l'utilisateur.

Paramètres

Renvoie

  • Promise<PermissionLevel>

    Chrome 116 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

update()

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

Met à jour une notification existante.

Paramètres

  • notificationId

    chaîne

    ID de la notification à mettre à jour. Cette valeur est renvoyée par la méthode notifications.create.

  • Contenu de la notification à modifier.

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    (wasUpdated: boolean) => void

    • wasUpdated

      booléen

Renvoie

  • Promise<boolean>

    Chrome 116 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

Événements

onButtonClicked

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

L'utilisateur a appuyé sur un bouton de la notification.

Paramètres

  • callback

    fonction

    Le paramètre callback se présente comme suit : 

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

    • notificationId

      chaîne

    • buttonIndex

      Total

onClicked

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

L'utilisateur a cliqué sur une zone de la notification qui n'est pas un bouton.

Paramètres

  • callback

    fonction

    Le paramètre callback se présente comme suit : 

    (notificationId: string) => void

    • notificationId

      chaîne

onClosed

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

La notification a été fermée par le système ou par l'utilisateur.

Paramètres

  • callback

    fonction

    Le paramètre callback se présente comme suit : 

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

    • notificationId

      chaîne

    • byUser

      booléen

onPermissionLevelChanged

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

L'utilisateur modifie le niveau d'autorisation. Depuis Chrome 47, seule l'UI de ChromeOS envoie cet événement.

Paramètres

onShowSettings

Obsolète depuis Chrome 65
chrome.notifications.onShowSettings.addListener(
  callback: function,
)

Le bouton des paramètres de notification personnalisés n'est plus disponible.

L'utilisateur a cliqué sur un lien vers les paramètres de notification de l'application. Depuis Chrome 47, seule l'UI de ChromeOS envoie cet événement. Depuis Chrome 65, cette interface utilisateur a également été supprimée de ChromeOS.

Paramètres

  • callback

    fonction

    Le paramètre callback se présente comme suit : 

    () => void