chrome.notifications

Description

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

Autorisations

notifications

Types

NotificationBitmap

NotificationButton

Propriétés

  • iconUrl

    chaîne facultatif

    <ph type="x-smartling-placeholder"></ph> Obsolète depuis Chrome 59

    Icônes de bouton non visibles par les utilisateurs de Mac OS X.

  • titre

    chaîne

NotificationItem

Propriétés

  • message

    chaîne

    Informations supplémentaires sur cet article.

  • titre

    chaîne

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

NotificationOptions

Propriétés

  • appIconMaskUrl

    chaîne facultatif

    <ph type="x-smartling-placeholder"></ph> Obsolète depuis Chrome 59

    Le masque de l'icône d'application n'est pas visible par 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 être en 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 facultatif

    Autre contenu de notification avec une police moins épaisse.

  • eventTime

    numéro facultatif

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

  • iconUrl

    chaîne facultatif

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

    Les URL peuvent être une URL de données, une URL 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

    <ph type="x-smartling-placeholder"></ph> Obsolète depuis Chrome 59

    Elle n'est pas visible par les utilisateurs de Mac OS X.

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

  • isClickable

    Booléen facultatif

    <ph type="x-smartling-placeholder"></ph> Obsolète depuis Chrome 67

    Cette suggestion d'interface utilisateur est ignorée à partir de Chrome 67

  • articles

    NotificationItem[] facultatif

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

  • message

    chaîne facultatif

    Contenu de la notification principale.

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

  • priorité

    numéro facultatif

    La priorité est comprise entre -2 et 2. "-2" correspond à la priorité la plus faible. 2 correspond à la valeur la plus élevée. La valeur par défaut est zéro. Sur les plates-formes non compatibles avec le centre de notifications (Windows, Linux et Mac), les valeurs -2 et -1 entraînent une erreur, car les notifications associées à ces priorités ne sont pas affichées du tout.

  • progression

    numéro facultatif

    La progression actuelle est comprise entre 0 et 100.

  • requireInteraction

    Booléen facultatif

    Chrome (version 50 ou ultérieure)

    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

    Booléen facultatif

    Chrome 70 et versions ultérieures

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

  • titre

    chaîne facultatif

    Titre de la notification (par exemple, nom de l'expéditeur de l'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, restrictedMessage et jusqu'à deux boutons.

"image"
Contient une icône, un titre, un message,ExpandedMessage, 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.

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

Méthodes

clear()

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

Efface la notification spécifiée.

Paramètres

  • notificationId

    chaîne

    Identifiant de la notification à effacer. Cet élément est renvoyé par la méthode notifications.create.

  • rappel

    function facultatif

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

    (wasCleared: boolean) => void

    • wasCleared

      booléen

Renvoie

  • Promise&lt;boolean&gt;

    Chrome 116 et versions ultérieures

    Les promesses sont prises en charge dans Manifest V3 et versions ultérieures, mais les rappels sont fournis pour rétrocompatibilité. Vous ne pouvez pas utiliser les deux sur le même appel de fonction. La la promesse est résolue avec le même type que celui transmis au rappel.

create()

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

Crée et affiche une notification.

Paramètres

  • notificationId

    chaîne facultatif

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

    Le paramètre notificationId est requis avant Chrome 42.

  • Contenu de la notification.

  • rappel

    function facultatif

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

    (notificationId: string) => void

    • notificationId

      chaîne

Renvoie

  • Promise&lt;string&gt;

    Chrome 116 et versions ultérieures

    Les promesses sont prises en charge dans Manifest V3 et versions ultérieures, mais les rappels sont fournis pour rétrocompatibilité. Vous ne pouvez pas utiliser les deux sur le même appel de fonction. La la promesse est résolue avec le même type que celui transmis au rappel.

getAll()

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

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

Paramètres

  • rappel

    function facultatif

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

    (notifications: object) => void

    • notifications

      objet

Renvoie

  • Promise&lt;object&gt;

    Chrome 116 et versions ultérieures

    Les promesses sont prises en charge dans Manifest V3 et versions ultérieures, mais les rappels sont fournis pour rétrocompatibilité. Vous ne pouvez pas utiliser les deux sur le même appel de fonction. La la promesse est résolue avec le même type que celui transmis au rappel.

getPermissionLevel()

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

Détermine si l'utilisateur a activé les notifications pour cette application ou extension.

Paramètres

Renvoie

  • Promise&lt;PermissionLevel&gt;

    Chrome 116 et versions ultérieures

    Les promesses sont prises en charge dans Manifest V3 et versions ultérieures, mais les rappels sont fournis pour rétrocompatibilité. Vous ne pouvez pas utiliser les deux sur le même appel de fonction. La la promesse est résolue avec le même type que celui transmis au rappel.

update()

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

Met à jour une notification existante.

Paramètres

  • notificationId

    chaîne

    Identifiant de la notification à mettre à jour. Cet élément est renvoyé par la méthode notifications.create.

  • Contenu de la notification à mettre à jour.

  • rappel

    function facultatif

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

    (wasUpdated: boolean) => void

    • wasUpdated

      booléen

Renvoie

  • Promise&lt;boolean&gt;

    Chrome 116 et versions ultérieures

    Les promesses sont prises en charge dans Manifest V3 et versions ultérieures, mais les rappels sont fournis pour rétrocompatibilité. Vous ne pouvez pas utiliser les deux sur le même appel de fonction. La la promesse est résolue avec le même type que celui transmis au rappel.

Événements

onButtonClicked

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

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

Paramètres

  • rappel

    fonction

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

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

    • notificationId

      chaîne

    • buttonIndex

      Nombre

onClicked

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

L'utilisateur a cliqué dans une zone sans bouton de la notification.

Paramètres

  • rappel

    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 s'est fermée, soit par le système, soit par une action de l'utilisateur.

Paramètres

  • rappel

    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, seul ChromeOS dispose d'une UI qui envoie cet événement.

Paramètres

onShowSettings

<ph type="x-smartling-placeholder"></ph> 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 pour accéder aux paramètres de notification de l'application. Depuis Chrome 47, seul ChromeOS dispose d'une UI qui envoie cet événement. À partir de Chrome 65, cette UI a également été supprimée de ChromeOS.

Paramètres

  • rappel

    fonction

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

    () => void