chrome.gcm

Descrizione

Utilizza chrome.gcm per consentire ad app ed estensioni di inviare e ricevere messaggi tramite Firebase Cloud Messaging (FCM).

Autorizzazioni

gcm

Proprietà

MAX_MESSAGE_SIZE

La dimensione massima (in byte) di tutte le coppie chiave/valore in un messaggio.

Valore

4096

Metodi

register()

Promessa 
chrome.gcm.register(
  senderIds: string[],
  callback?: function,
): Promise<string>

Registra l'applicazione con FCM. L'ID registrazione verrà restituito da callback. Se register viene chiamato di nuovo con lo stesso elenco di senderIds, verrà restituito lo stesso ID registrazione.

Parametri

  • senderIds

    string[]

    Un elenco di ID server autorizzati a inviare messaggi all'applicazione. Deve contenere almeno un ID mittente e non più di 100.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (registrationId: string) => void

    • registrationId

      stringa

      Un ID registrazione assegnato all'applicazione da FCM.

Resi

  • Promise<string>

    Chrome 116+

    Le promesse sono supportate solo per Manifest V3 e versioni successive, le altre piattaforme devono utilizzare i callback.

send()

Promessa 
chrome.gcm.send(
  message: object,
  callback?: function,
): Promise<string>

Invia un messaggio in base ai suoi contenuti.

Parametri

  • messaggio

    oggetto

    Un messaggio da inviare all'altra parte tramite FCM.

    • dati

      oggetto

      Dati del messaggio da inviare al server. goog. e google senza distinzione tra maiuscole e minuscole, nonché collapse_key con distinzione tra maiuscole e minuscole, non sono consentiti come prefissi delle chiavi. La somma di tutte le coppie chiave/valore non deve superare gcm.MAX_MESSAGE_SIZE.

    • destinationId

      stringa

      L'ID del server a cui inviare il messaggio assegnato dalla console API di Google.

    • messageId

      stringa

      L'ID del messaggio. Deve essere univoco per ogni messaggio nell'ambito delle applicazioni. Consulta la documentazione di Cloud Messaging per suggerimenti sulla scelta e sulla gestione di un ID.

    • timeToLive

      number (facoltativo)

      Il tempo di permanenza del messaggio in secondi. Se non è possibile inviare il messaggio entro questo periodo di tempo, verrà generato un evento onSendError. Un TTL pari a 0 indica che il messaggio deve essere inviato immediatamente o non riuscirà a essere inviato. Il valore predefinito del time-to-live è 86.400 secondi (1 giorno) e il valore massimo è 2.419.200 secondi (28 giorni).

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (messageId: string) => void

    • messageId

      stringa

      L'ID del messaggio per cui è stato emesso il callback.

Resi

  • Promise<string>

    Chrome 116+

    Le promesse sono supportate solo per Manifest V3 e versioni successive, le altre piattaforme devono utilizzare i callback.

unregister()

Promessa 
chrome.gcm.unregister(
  callback?: function,
): Promise<void>

Annulla la registrazione dell'applicazione da FCM.

Parametri

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    () => void

Resi

  • Promise<void>

    Chrome 116+

    Le promesse sono supportate solo per Manifest V3 e versioni successive, le altre piattaforme devono utilizzare i callback.

Eventi

onMessage

chrome.gcm.onMessage.addListener(
  callback: function,
)

Attivato quando viene ricevuto un messaggio tramite FCM.

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto: 

    (message: object) => void

    • messaggio

      oggetto

      • collapseKey

        stringa facoltativa

        La chiave di compressione di un messaggio. Per maggiori dettagli, consulta Messaggi comprimibili e non comprimibili.

      • dati

        oggetto

        I dati del messaggio.

      • da

        stringa facoltativa

        Il mittente che ha emesso il messaggio.

onMessagesDeleted

chrome.gcm.onMessagesDeleted.addListener(
  callback: function,
)

Attivato quando un server FCM ha dovuto eliminare i messaggi inviati da un server delle app all'applicazione. Per informazioni dettagliate sulla gestione di questo evento, consulta Durata di un messaggio.

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto: 

    () => void

onSendError

chrome.gcm.onSendError.addListener(
  callback: function,
)

Attivato quando non è stato possibile inviare un messaggio al server FCM.

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto: 

    (error: object) => void

    • errore

      oggetto

      • dettagli

        oggetto

        Ulteriori dettagli relativi all'errore, se disponibili.

      • errorMessage

        stringa

        Il messaggio di errore che descrive il problema.

      • messageId

        stringa facoltativa

        L'ID del messaggio con questo errore, se l'errore è correlato a un messaggio specifico.