browser.notifications

Description

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

Autorisations

notifications

Types

NotificationBitmap

NotificationButton

Propriétés

  • iconUrl

    chaîne facultatif

    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 facultatif

    Obsolète depuis Chrome 59

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

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

    Le masque de l'icône d'application doit se trouver 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 ou deux boutons d'action de notification.

  • contextMessage

    chaîne facultatif

    Contenu de notification alternatif avec une police moins épaisse.

  • eventTime

    number facultatif

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

  • iconUrl

    chaîne facultatif

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

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

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

  • imageUrl

    chaîne facultatif

    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

    boolean facultatif

    Obsolète depuis Chrome 67

    Cette indication d'UI est ignorée à partir de Chrome 67

  • éléments

    NotificationItem[] facultatif

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

  • message

    chaîne facultatif

    Contenu principal de la notification.

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

  • priorité

    number facultatif

    La priorité est comprise entre -2 et 2. -2 correspond à la priorité la plus faible. 2 est 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 ayant ces priorités ne s'affichent pas du tout.

  • progression

    number facultatif

    La progression actuelle est comprise entre 0 et 100.

  • requireInteraction

    boolean facultatif

    Chrome 50 ou version ultérieure browser.* depuis Chrome 148

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

  • silencieux

    boolean facultatif

    Chrome 70+ browser.* depuis Chrome 148

    Indique qu'aucun son ni aucune vibration ne doivent être émis lorsque la notification est affichée. La valeur par défaut est "false".

  • titre

    chaîne facultatif

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

    **Remarque** : Cette valeur est obligatoire 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 de la valeur par défaut au moment 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()

browser.notifications.clear(
  notificationId: string,
): 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.

Renvoie

  • Promise<boolean>

    Chrome 116+ browser.* depuis Chrome 148

    Renvoie une promesse qui se résout pour indiquer si une notification correspondante existait.

create()

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

Crée et affiche une notification.

Paramètres

  • notificationId

    chaîne facultatif

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

    Le paramètre notificationId est obligatoire avant Chrome 42.

  • Contenu de la notification.

Renvoie

  • Promise<string>

    Chrome 116+ browser.* depuis Chrome 148

    Renvoie une promesse qui se résout avec l'ID de notification (fourni ou généré) représentant la notification créée.

getAll()

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

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

Renvoie

  • Promise<object>

    Chrome 116+ browser.* depuis Chrome 148

    Renvoie une promesse qui se résout avec l'ensemble des notification_ids actuellement dans le système.

getPermissionLevel()

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

Indique si l'utilisateur a activé les notifications de cette application ou extension.

Renvoie

  • Promise<PermissionLevel>

    Chrome 116+ browser.* depuis Chrome 148

    Renvoie une promesse qui se résout avec le niveau d'autorisation actuel.

update()

browser.notifications.update(
  notificationId: string,
  options: NotificationOptions,
): 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 à mettre à jour.

Renvoie

  • Promise<boolean>

    Chrome 116+ browser.* depuis Chrome 148

    Renvoie une promesse qui se résout pour indiquer si une notification correspondante existait.

Événements

onButtonClicked

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

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

Paramètres

  • callback

    fonction

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

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

    • notificationId

      chaîne

    • buttonIndex

      nombre

onClicked

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

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

La notification a été fermée, soit par le système, soit 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

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

L'utilisateur modifie le niveau d'autorisation. Depuis Chrome 47, seul ChromeOS dispose d'une UI qui distribue cet événement.

Paramètres

onShowSettings

Obsolète depuis Chrome 65
browser.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, seul ChromeOS dispose d'une UI qui distribue 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