Descrizione
Utilizza l'API chrome.notifications
per creare notifiche avanzate utilizzando i modelli e mostrare queste notifiche agli utenti nella barra delle applicazioni.
Autorizzazioni
notifications
Tipi
NotificationBitmap
NotificationButton
Proprietà
-
iconUrl
stringa facoltativo
Obsoleto da Chrome 59Icone dei pulsanti non visibili per gli utenti di Mac OS X.
-
title
stringa
NotificationItem
Proprietà
-
messaggio
stringa
Ulteriori dettagli su questo elemento.
-
title
stringa
Titolo di una voce di una notifica di elenco.
NotificationOptions
Proprietà
-
appIconMaskUrl
stringa facoltativo
Obsoleto da Chrome 59La maschera dell'icona dell'app non è visibile per gli utenti di Mac OS X.
Un URL per la maschera dell'icona dell'app. Gli URL hanno le stesse limitazioni di iconUrl.
La maschera dell'icona dell'app deve essere nel canale alfa, poiché verrà preso in considerazione solo il canale alfa dell'immagine.
-
pulsanti
NotificationButton[] facoltativo
Testo e icone per un massimo di due pulsanti di azione di notifica.
-
contextMessage
stringa facoltativo
Alterna i contenuti delle notifiche con un carattere di dimensioni inferiori.
-
eventTime
numero facoltativo
Un timestamp associato alla notifica, in millisecondi successiva all'epoca (ad es.
Date.now() + n
). -
iconUrl
stringa facoltativo
Un URL che rimanda all'avatar del mittente, all'icona dell'app o a una miniatura per le notifiche relative alle immagini.
Gli URL possono essere un URL di dati, un URL blob o un URL relativo a una risorsa all'interno del file .crx di questa estensione
**Nota:**questo valore è obbligatorio per il metodo
notifications.create
()
. -
imageUrl
stringa facoltativo
Obsoleto da Chrome 59L'immagine non è visibile per gli utenti Mac OS X.
Un URL alla miniatura dell'immagine per le notifiche relative al tipo di immagine. Gli URL hanno le stesse limitazioni di iconUrl.
-
isClickable
booleano facoltativo
Obsoleto da Chrome 67Questo suggerimento dell'interfaccia utente viene ignorato a partire da Chrome 67
-
items
NotificationItem[] facoltativo
Elementi per le notifiche relative a più elementi. Gli utenti di Mac OS X vedranno solo il primo elemento.
-
messaggio
stringa facoltativo
Contenuti della notifica principale.
**Nota:**questo valore è obbligatorio per il metodo
notifications.create
()
. -
delle campagne
numero facoltativo
La priorità va da -2 a 2. -2 è la priorità più bassa. 2 è il valore più alto. Il valore predefinito è zero. Sulle piattaforme che non supportano un centro notifiche (Windows, Linux e Mac), i valori -2 e -1 generano un errore perché le notifiche con queste priorità non vengono mostrate.
-
Avanzamento
numero facoltativo
L'avanzamento attuale va da 0 a 100.
-
requireInteraction
booleano facoltativo
Chrome 50 e versioni successiveIndica che la notifica deve rimanere visibile sullo schermo fino a quando l'utente non la attiva o la elimina. Il valore predefinito è false.
-
silenzioso
booleano facoltativo
Chrome 70 e versioni successiveIndica che non devono essere emessi suoni o vibrazioni quando la notifica viene mostrata. Il valore predefinito è false.
-
title
stringa facoltativo
Titolo della notifica (ad es. nome del mittente per l'email).
**Nota:**questo valore è obbligatorio per il metodo
notifications.create
()
. -
Tipo
TemplateType facoltativo
Quale tipo di notifica visualizzare. Obbligatorio per il metodo
notifications.create
.
PermissionLevel
Enum
"granted"
Specifica che l'utente ha scelto di mostrare notifiche dell'app o dell'estensione. Questa è l'impostazione predefinita al momento dell'installazione.
"negato"
Specifica che l'utente ha scelto di non mostrare notifiche dell'app o dell'estensione.
TemplateType
Enum
"basic"
Contiene un'icona, un titolo, un messaggio, expandMessage e fino a due pulsanti.
"image"
Contiene un'icona, un titolo, un messaggio, expandMessage, un'immagine e fino a due pulsanti.
"list"
Contiene un'icona, un titolo, un messaggio, elementi e fino a due pulsanti. Gli utenti di Mac OS X vedranno solo il primo elemento.
"progress"
Contiene un'icona, un titolo, un messaggio, l'avanzamento e fino a due pulsanti.
Metodi
clear()
chrome.notifications.clear(
notificationId: string,
callback?: function,
)
Cancella la notifica specificata.
Parametri
-
notificationId
stringa
L'ID della notifica da cancellare. Questo viene restituito dal metodo
notifications.create
. -
callback
funzione facoltativa
Il parametro
callback
ha il seguente aspetto:(wasCleared: boolean) => void
-
wasCleared
boolean
-
Ritorni
-
Promise<boolean>
Chrome 116 e versioni successiveLe promesse sono supportate solo per Manifest V3 e versioni successive; altre piattaforme devono utilizzare i callback.
create()
chrome.notifications.create(
notificationId?: string,
options: NotificationOptions,
callback?: function,
)
Crea e visualizza una notifica.
Parametri
-
notificationId
stringa facoltativo
Identificatore della notifica. Se non viene impostato o se viene lasciato vuoto, verrà generato automaticamente un ID. Se corrisponde a una notifica esistente, questo metodo la cancella prima di procedere con l'operazione di creazione. L'identificatore non può contenere più di 500 caratteri.
Il parametro
notificationId
è obbligatorio prima di Chrome 42. -
opzioni del modello.
Contenuto della notifica.
-
callback
funzione facoltativa
Il parametro
callback
ha il seguente aspetto:(notificationId: string) => void
-
notificationId
stringa
-
Ritorni
-
Promessa<string>
Chrome 116 e versioni successiveLe promesse sono supportate solo per Manifest V3 e versioni successive; altre piattaforme devono utilizzare i callback.
getAll()
chrome.notifications.getAll(
callback?: function,
)
Recupera tutte le notifiche di questa app o estensione.
Parametri
-
callback
funzione facoltativa
Il parametro
callback
ha il seguente aspetto:(notifications: object) => void
-
notifiche
oggetto
-
Ritorni
-
Promise<object>
Chrome 116 e versioni successiveLe promesse sono supportate solo per Manifest V3 e versioni successive; altre piattaforme devono utilizzare i callback.
getPermissionLevel()
chrome.notifications.getPermissionLevel(
callback?: function,
)
Recupera se l'utente ha attivato le notifiche da questa app o estensione.
Parametri
-
callback
funzione facoltativa
Il parametro
callback
ha il seguente aspetto:(level: PermissionLevel) => void
-
livello
-
Ritorni
-
Promise<PermissionLevel>
Chrome 116 e versioni successiveLe promesse sono supportate solo per Manifest V3 e versioni successive; altre piattaforme devono utilizzare i callback.
update()
chrome.notifications.update(
notificationId: string,
options: NotificationOptions,
callback?: function,
)
Consente di aggiornare una notifica esistente.
Parametri
-
notificationId
stringa
L'ID della notifica da aggiornare. Questo viene restituito dal metodo
notifications.create
. -
opzioni del modello.
Contenuto della notifica a cui eseguire l'aggiornamento.
-
callback
funzione facoltativa
Il parametro
callback
ha il seguente aspetto:(wasUpdated: boolean) => void
-
wasUpdated
boolean
-
Ritorni
-
Promise<boolean>
Chrome 116 e versioni successiveLe promesse sono supportate solo per Manifest V3 e versioni successive; altre piattaforme devono utilizzare i callback.
Eventi
onButtonClicked
chrome.notifications.onButtonClicked.addListener(
callback: function,
)
L'utente ha premuto un pulsante nella notifica.
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(notificationId: string, buttonIndex: number) => void
-
notificationId
stringa
-
buttonIndex
numero
-
onClicked
chrome.notifications.onClicked.addListener(
callback: function,
)
L'utente ha fatto clic in un'area non corrispondente al pulsante della notifica.
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(notificationId: string) => void
-
notificationId
stringa
-
onClosed
chrome.notifications.onClosed.addListener(
callback: function,
)
La notifica è stata chiusa dal sistema o per azione dell'utente.
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(notificationId: string, byUser: boolean) => void
-
notificationId
stringa
-
byUser
boolean
-
onPermissionLevelChanged
chrome.notifications.onPermissionLevelChanged.addListener(
callback: function,
)
L'utente cambia il livello di autorizzazione. A partire da Chrome 47, solo ChromeOS dispone di una UI che invia questo evento.
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(level: PermissionLevel) => void
-
livello
-
onShowSettings
chrome.notifications.onShowSettings.addListener(
callback: function,
)
Il pulsante delle impostazioni di notifica personalizzate non è più supportato.
L'utente ha fatto clic su un link per le impostazioni di notifica dell'app. A partire da Chrome 47, solo ChromeOS dispone di una UI che invia questo evento. A partire da Chrome 65, anche questa UI è stata rimossa da ChromeOS.
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:() => void