Description
Utilisez l'API chrome.notifications
pour créer des notifications enrichies à l'aide de modèles et afficher ces notifications aux utilisateurs dans la barre d'état système.
Autorisations
notifications
Types
NotificationBitmap
NotificationButton
Propriétés
-
iconUrl
string facultatif
Obsolète depuis Chrome 59Les icônes de bouton ne sont pas visibles pour les utilisateurs de Mac OS X.
-
title
chaîne
NotificationItem
Propriétés
-
message
chaîne
Informations supplémentaires sur cet article.
-
title
chaîne
Titre d'un élément d'une notification de liste.
NotificationOptions
Propriétés
-
appIconMaskUrl
string facultatif
Obsolète depuis Chrome 59Le 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 être en version alpha, car seul le canal alpha de l'image est pris en compte.
-
boutons
NotificationButton[] facultatif
Texte et icônes de deux boutons d'action pour les notifications au maximum.
-
contextMessage
string facultatif
Autre contenu de notification avec une police moins épaisse.
-
eventTime
numéro facultatif
Un code temporel associé à la notification, en millisecondes après l'epoch (par exemple,
Date.now() + n
). -
iconUrl
string facultatif
URL de l'avatar de l'expéditeur, de l'icône d'application ou d'une vignette pour les notifications d'image.
Il peut s'agir d'une URL de données, d'une URL d'objet blob ou d'une URL relative à une ressource dans le fichier .crx de cette extension.
**Remarque:**Cette valeur est obligatoire pour la méthode
()
notifications.create
. -
imageUrl
string facultatif
Obsolète depuis Chrome 59Les utilisateurs de Mac OS X ne peuvent pas voir l'image.
URL vers la vignette de l'image pour les notifications par type d'image. Les URL sont soumises aux mêmes restrictions que iconUrl.
-
isClickable
Booléen facultatif
Obsolète depuis Chrome 67Cet indice d'UI est ignoré à partir de Chrome 67
-
items
NotificationItem[] facultatif
Articles pour les notifications relatives à plusieurs articles. Les utilisateurs de Mac OS X ne voient que le premier élément.
-
message
string facultatif
Contenu des notifications principales.
**Remarque:**Cette valeur est obligatoire pour la méthode
()
notifications.create
. -
campagne
numéro facultatif
La priorité est comprise entre -2 et 2. -2 est la priorité la plus faible. 2 est le plus élevé. La valeur par défaut est zéro. Sur les plates-formes non compatibles avec un centre de notifications (Windows, Linux et Mac), -2 et -1 génèrent une erreur, car les notifications associées à ces priorités ne s'affichent pas du tout.
-
progression
numéro facultatif
La progression actuelle est comprise entre 0 et 100.
-
requireInteraction
Booléen facultatif
Chrome 50 et versions ultérieuresIndique 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érieuresIndique qu'aucun son ni vibration ne doivent être émis lorsque la notification s'affiche. La valeur par défaut est "false".
-
title
string 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
Enum
"accordé"
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 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
Enum
"basic"
Contient une icône, un titre, un message, un message étendu et jusqu'à deux boutons.
"image"
Contient une icône, un titre, un message, un message étendu, 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, la progression et jusqu'à deux boutons.
Méthodes
clear()
chrome.notifications.clear(
notificationId: string,
callback?: function,
)
Efface la notification spécifiée.
Paramètres
-
notificationId
chaîne
Identifiant de la notification à effacer. Cette valeur est renvoyée par la méthode
notifications.create
. -
rappel
fonction facultative
Le paramètre
callback
se présente comme suit :(wasCleared: boolean) => void
-
wasCleared
boolean
-
Renvoie
-
Promise<boolean>
Chrome 116 et versions ultérieuresLes promesses ne sont compatibles qu'avec Manifest V3 et versions ultérieures. Les autres plates-formes doivent utiliser des rappels.
create()
chrome.notifications.create(
notificationId?: string,
options: NotificationOptions,
callback?: function,
)
Crée et affiche une notification.
Paramètres
-
notificationId
string facultatif
Identifiant de la notification. Si cette règle n'est pas configurée ou qu'elle est vide, un ID est généré automatiquement. Si elle correspond à une notification existante, cette méthode efface cette notification avant de poursuivre l'opération de création. L'identifiant ne doit pas dépasser 500 caractères.
Le paramètre
notificationId
est obligatoire avant Chrome 42. -
options
Contenu de la notification.
-
rappel
fonction facultative
Le paramètre
callback
se présente comme suit :(notificationId: string) => void
-
notificationId
chaîne
-
Renvoie
-
Promesse<chaîne>
Chrome 116 et versions ultérieuresLes promesses ne sont compatibles qu'avec Manifest V3 et versions ultérieures. Les autres plates-formes doivent utiliser des rappels.
getAll()
chrome.notifications.getAll(
callback?: function,
)
Récupère toutes les notifications de cette application ou de cette extension.
Paramètres
-
rappel
fonction facultative
Le paramètre
callback
se présente comme suit :(notifications: object) => void
-
notifications
objet
-
Renvoie
-
Promise<object>
Chrome 116 et versions ultérieuresLes promesses ne sont compatibles qu'avec Manifest V3 et versions ultérieures. Les autres plates-formes doivent utiliser des rappels.
getPermissionLevel()
chrome.notifications.getPermissionLevel(
callback?: function,
)
Détermine si l'utilisateur a activé les notifications de cette application ou de cette extension.
Paramètres
-
rappel
fonction facultative
Le paramètre
callback
se présente comme suit :(level: PermissionLevel) => void
-
level
-
Renvoie
-
Promise<PermissionLevel>
Chrome 116 et versions ultérieuresLes promesses ne sont compatibles qu'avec Manifest V3 et versions ultérieures. Les autres plates-formes doivent utiliser des rappels.
update()
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. Cette valeur est renvoyée par la méthode
notifications.create
. -
options
Contenu de la notification à mettre à jour.
-
rappel
fonction facultative
Le paramètre
callback
se présente comme suit :(wasUpdated: boolean) => void
-
wasUpdated
boolean
-
Renvoie
-
Promise<boolean>
Chrome 116 et versions ultérieuresLes promesses ne sont compatibles qu'avec Manifest V3 et 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 dans la notification.
Paramètres
-
rappel
function
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 de la notification qui n'est pas un bouton.
Paramètres
-
rappel
function
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, soit par le système, soit par une action de l'utilisateur.
Paramètres
-
rappel
function
Le paramètre
callback
se présente comme suit :(notificationId: string, byUser: boolean) => void
-
notificationId
chaîne
-
byUser
boolean
-
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
-
rappel
function
Le paramètre
callback
se présente comme suit :(level: PermissionLevel) => void
-
level
-
onShowSettings
chrome.notifications.onShowSettings.addListener(
callback: function,
)
Le bouton des paramètres de notification personnalisés n'est plus pris en charge.
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 envoie cet événement. Depuis Chrome 65, cette UI a également été supprimée de ChromeOS.
Paramètres
-
rappel
function
Le paramètre
callback
se présente comme suit :() => void