chrome.notifications

Descrizione

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

Autorizzazioni

notifications

Tipi

NotificationBitmap

NotificationButton

Proprietà

  • iconUrl

    stringa facoltativa

    Ritirato da Chrome 59

    Le icone dei pulsanti non sono visibili agli utenti di Mac OS X.

  • titolo

    stringa

NotificationItem

Proprietà

  • messaggio

    stringa

    Ulteriori dettagli su questo elemento.

  • titolo

    stringa

    Titolo di un elemento di una notifica di elenco.

NotificationOptions

Proprietà

  • appIconMaskUrl

    stringa facoltativa

    Ritirato da Chrome 59

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

    Un URL che rimanda alla 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à considerato solo il canale alfa dell'immagine.

  • pulsanti

    NotificationButton[] facoltativo

    Testo e icone per un massimo di due pulsanti di azione di notifica.

  • contextMessage

    stringa facoltativa

    Contenuti di notifica alternativi con un carattere di peso inferiore.

  • eventTime

    number (facoltativo)

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

  • iconUrl

    stringa facoltativa

    Un URL dell'avatar del mittente, dell'icona dell'app o di una miniatura per le notifiche con immagini.

    Gli URL possono essere un URL 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 facoltativa

    Ritirato da Chrome 59

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

    Un URL che rimanda alla miniatura dell'immagine per le notifiche di tipo immagine. Gli URL hanno le stesse limitazioni di iconUrl.

  • isClickable

    booleano facoltativo

    Ritirato a partire da Chrome 67

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

  • elementi

    NotificationItem[] facoltativo

    Elementi per le notifiche multi-articolo. Gli utenti di Mac OS X vedono solo il primo elemento.

  • messaggio

    stringa facoltativa

    Contenuti principali della notifica.

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

  • priorità

    number (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), -2 e -1 generano un errore perché le notifiche con queste priorità non verranno visualizzate.

  • avanzamento

    number (facoltativo)

    L'avanzamento attuale varia da 0 a 100.

  • requireInteraction

    booleano facoltativo

    Chrome 50 o versioni successive

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

  • silenzioso

    booleano facoltativo

    Chrome 70+

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

  • titolo

    stringa facoltativa

    Titolo della notifica (ad es. nome del mittente per l'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

"concesso"
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, un messaggio espanso 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, l'avanzamento e fino a due pulsanti.

Metodi

clear()

chrome.notifications.clear(
  notificationId: string,
): Promise<boolean>

Cancella la notifica specificata.

Parametri

  • notificationId

    stringa

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

Resi

  • Promise<boolean>

    Chrome 116+

create()

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

Crea e visualizza una notifica.

Parametri

  • notificationId

    stringa facoltativa

    Identificatore della notifica. Se non è impostato o è 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.

  • Contenuti della notifica.

Resi

  • Promise<string>

    Chrome 116+

getAll()

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

Recupera tutte le notifiche di questa app o estensione.

Resi

  • Promise<object>

    Chrome 116+

getPermissionLevel()

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

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

Resi

update()

chrome.notifications.update(
  notificationId: string,
  options: NotificationOptions,
): Promise<boolean>

Aggiorna una notifica esistente.

Parametri

Resi

  • Promise<boolean>

    Chrome 116+

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 su un'area della notifica diversa da un pulsante.

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 dall'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 ha un'interfaccia utente che invia questo evento.

Parametri

onShowSettings

Ritirato a partire 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 per le impostazioni di notifica dell'app. A partire da Chrome 47, solo ChromeOS ha un'interfaccia utente che invia questo evento. A partire da Chrome 65, questa UI è stata rimossa anche da ChromeOS.

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto: 

    () => void