chrome.notifications

Descrizione

Usa l'API chrome.notifications per creare notifiche avanzate utilizzando modelli e mostrare queste notifiche agli utenti nella barra delle applicazioni.

Autorizzazioni

notifications

Tipi

NotificationBitmap

NotificationButton

Proprietà

  • iconUrl

    stringa facoltativo

    Ritirato da Chrome 59

    Icone dei pulsanti non visibili per gli utenti di Mac OS X.

  • titolo

    stringa

NotificationItem

Proprietà

  • messaggio

    stringa

    Ulteriori dettagli su questo elemento.

  • titolo

    stringa

    Titolo di una voce di una notifica di elenco.

NotificationOptions

Proprietà

  • appIconMaskUrl

    stringa facoltativo

    Ritirato da Chrome 59

    La maschera dell'icona dell'app non è visibile per gli utenti di Mac OS X.

    Un URL alla maschera dell'icona dell'app. Gli URL hanno le stesse restrizioni di iconUrl.

    La maschera dell'icona dell'app deve essere nel canale alfa, in quanto verrà preso in considerazione solo il canale alfa dell'immagine.

  • pulsanti

    NotificationButton[] facoltativo

    Testo e icone per un massimo di due pulsanti di azione delle notifiche.

  • contextMessage

    stringa facoltativo

    Contenuti alternativi delle notifiche con un carattere di dimensioni inferiori.

  • eventTime

    numero facoltativo

    Un timestamp associato alla notifica, in millisecondi dopo l'epoca (ad es. Date.now() + n).

  • iconUrl

    stringa facoltativo

    Un URL che rimanda all'avatar, all'icona dell'app o a una miniatura per le notifiche relative a immagini del mittente.

    Gli URL possono essere un URL di dati, un URL del blob o un URL relativo a una risorsa nel file .crx di questa estensione

    **Nota:**questo valore è obbligatorio per il metodo notifications.create().

  • imageUrl

    stringa facoltativo

    Ritirato da Chrome 59

    L'immagine non è visibile per gli utenti di Mac OS X.

    Un URL alla miniatura dell'immagine per le notifiche relative al tipo di immagine. Gli URL hanno le stesse restrizioni di iconUrl.

  • isClickable

    booleano facoltativo

    Ritirato da Chrome 67

    Questo suggerimento relativo all'interfaccia utente viene ignorato a partire da Chrome 67

  • elementi

    NotificationItem[] facoltativo

    Articoli per le notifiche con 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().

  • priorità

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

  • avanzamento

    numero facoltativo

    L'avanzamento attuale va da 0 a 100.

  • requireInteraction

    booleano facoltativo

    Chrome 50 e versioni successive .

    Indica che la notifica deve rimanere visibile sullo schermo finché l'utente non la attiva o la ignora. Il valore predefinito è false.

  • silenzioso

    booleano facoltativo

    Chrome 70 e versioni successive .

    Indica che non devono essere emessi suoni o vibrazioni quando viene visualizzata la notifica. Il valore predefinito è false.

  • titolo

    stringa facoltativo

    Titolo della notifica (ad es. nome del mittente dell'email).

    **Nota:**questo valore è obbligatorio per il metodo notifications.create().

  • tipo

    TemplateType facoltativo

    Il tipo di notifica da visualizzare. Obbligatorio per il metodo notifications.create.

PermissionLevel

Enum

"granted"
Specifica che l'utente ha scelto di mostrare le notifiche dell'app o dell'estensione. Questa è l'impostazione predefinita al momento dell'installazione.

"denied"
Specifica che l'utente ha scelto di non mostrare le notifiche dell'app o dell'estensione.

TemplateType

Enum

"basic"
Contiene un'icona, un titolo, un messaggio, espansoMessage e fino a due pulsanti.

"image"
Contiene un'icona, un titolo, un messaggio, un messaggio espanso, 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 vedono solo il primo elemento.

"progress"
Contiene un'icona, un titolo, un messaggio, un avanzamento e fino a due pulsanti.

Metodi

clear()

Promesso .
chrome.notifications.clear(
  notificationId: string,
  callback?: function,
)

Cancella la notifica specificata.

Parametri

  • notificationId

    stringa

    L'ID della notifica da cancellare. Questo valore viene restituito dal metodo notifications.create.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (wasCleared: boolean) => void

    • wasCleared

      booleano

Resi

  • Promise<boolean>

    Chrome 116 e versioni successive .

    Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

create()

Promesso .
chrome.notifications.create(
  notificationId?: string,
  options: NotificationOptions,
  callback?: function,
)

Crea e visualizza una notifica.

Parametri

  • notificationId

    stringa facoltativo

    Identificatore della notifica. Se non viene configurato 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 della versione 42 di Chrome.

  • Contenuti della notifica.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (notificationId: string) => void

    • notificationId

      stringa

Resi

  • Promise<string>

    Chrome 116 e versioni successive .

    Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

getAll()

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

Resi

  • Promise<object>

    Chrome 116 e versioni successive .

    Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

getPermissionLevel()

Promesso .
chrome.notifications.getPermissionLevel(
  callback?: function,
)

Recupera se l'utente ha attivato le notifiche da questa app o estensione.

Parametri

Resi

  • Promise<PermissionLevel>

    Chrome 116 e versioni successive .

    Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

update()

Promesso .
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 valore viene restituito dal metodo notifications.create.

  • Contenuti della notifica a cui eseguire l'aggiornamento.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (wasUpdated: boolean) => void

    • wasUpdated

      booleano

Resi

  • Promise<boolean>

    Chrome 116 e versioni successive .

    Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al 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 diversa dal 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 da un'azione dell'utente.

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto: 

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

    • notificationId

      stringa

    • byUser

      booleano

onPermissionLevelChanged

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

L'utente modifica il livello di autorizzazione. A partire da Chrome 47, solo ChromeOS dispone di una UI che invia questo evento.

Parametri

onShowSettings

Ritirato da Chrome 65
chrome.notifications.onShowSettings.addListener(
  callback: function,
)

Il pulsante delle impostazioni di notifica personalizzate non è più supportato.

L'utente ha fatto clic su un link alle 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