browser.notifications

Descrizione

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

Autorizzazioni

notifications

Tipi

NotificationBitmap

NotificationButton

Proprietà

  • iconUrl

    stringa facoltativa

    Ritirato da Chrome 59

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

  • titolo

    stringa

NotificationItem

Proprietà

  • messaggio

    stringa

    Dettagli aggiuntivi 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 agli 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 delle notifiche.

  • contextMessage

    stringa facoltativa

    Alterna i contenuti delle notifiche con un carattere più leggero.

  • eventTime

    number optional

    Un timestamp associato alla notifica, in millisecondi trascorsi dall'epoch (ad es. Date.now() + n).

  • iconUrl

    stringa facoltativa

    Un URL all'avatar del mittente, all'icona dell'app o a una miniatura per le notifiche con 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 facoltativa

    Ritirato da Chrome 59

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

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

  • isClickable

    boolean facoltativo

    Ritirato da Chrome 67

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

  • elementi

    NotificationItem[] facoltativo

    Elementi per le notifiche di più elementi. Gli utenti di Mac OS X vedono solo il primo elemento.

  • messaggio

    stringa facoltativa

    Contenuto principale della notifica.

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

  • priorità

    number optional

    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, poiché le notifiche con queste priorità non verranno mostrate affatto.

  • avanzamento

    number optional

    L'avanzamento attuale va da 0 a 100.

  • requireInteraction

    boolean facoltativo

    Chrome 50 e versioni successive browser.* da Chrome 148

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

  • silenzioso

    boolean facoltativo

    Browser Chrome 70 e versioni successive * da Chrome 148

    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

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

"image"
Contiene un'icona, un titolo, un messaggio, un expandedMessage, 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 indicatore di avanzamento e fino a due pulsanti.

Metodi

clear()

browser.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+ browser.* da Chrome 148

    Restituisce una Promise che si risolve per indicare se esisteva una notifica corrispondente.

create()

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

Crea e visualizza una notifica.

Parametri

  • notificationId

    stringa facoltativa

    Identificatore della notifica. Se non viene impostato o se è 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+ browser.* da Chrome 148

    Restituisce una Promise che si risolve con l'ID della notifica (fornito o generato) che rappresenta la notifica creata.

getAll()

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

Recupera tutte le notifiche di questa app o estensione.

Resi

  • Promise<object>

    Chrome 116+ browser.* da Chrome 148

    Restituisce una Promise che si risolve con l'insieme di notification_id attualmente presenti nel sistema.

getPermissionLevel()

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

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

Resi

  • Promise<PermissionLevel>

    Chrome 116+ browser.* da Chrome 148

    Restituisce una promessa che si risolve con il livello di autorizzazione corrente.

update()

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

Aggiorna una notifica esistente.

Parametri

Resi

  • Promise<boolean>

    Chrome 116+ browser.* da Chrome 148

    Restituisce una Promise che si risolve per indicare se esisteva una notifica corrispondente.

Eventi

onButtonClicked

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

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

L'utente ha fatto clic su un'area della notifica che non è un pulsante.

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto: 

    (notificationId: string) => void

    • notificationId

      stringa

onClosed

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

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

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

Parametri

onShowSettings

Ritirato da Chrome 65
browser.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 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