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()

Promesso .
chrome.gcm.register(
  senderIds: string[],
  callback?: function,
)

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

Parametri

  • senderIds

    stringa[]

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

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (registrationId: string) => void

    • registrationId

      stringa

      Un ID di registrazione assegnato all'applicazione da FCM.

Resi

  • Promise<string>

    Chrome 116 e versioni successive .

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

send()

Promesso .
chrome.gcm.send(
  message: object,
  callback?: function,
)

Invia un messaggio in base ai suoi contenuti.

Parametri

  • messaggio

    oggetto

    Un messaggio da inviare all'altra parte tramite FCM.

    • dati

      oggetto

      Dati dei messaggi da inviare al server. I prefissi chiave goog. e google, senza distinzione tra maiuscole e minuscole e collapse_key sensibili alle maiuscole, non sono consentiti. La somma di tutte le coppie chiave/valore non deve essere superiore a gcm.MAX_MESSAGE_SIZE.

    • destinationId

      stringa

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

    • messageId

      stringa

      L'ID del messaggio. Deve essere univoco per ciascun messaggio nell'ambito delle applicazioni. Per consigli su come scegliere e gestire un ID, consulta la documentazione di Cloud Messaging.

    • timeToLive

      numero facoltativo

      Durata del messaggio in secondi. Se non è possibile inviare il messaggio entro questo periodo di tempo, viene generato un evento onSendError. Una durata pari a 0 indica che il messaggio deve essere inviato immediatamente o non riesce se non è possibile. Il valore predefinito della durata (TTL) è 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 e versioni successive .

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

unregister()

Promesso .
chrome.gcm.unregister(
  callback?: function,
)

Consente di annullare la registrazione dell'applicazione da FCM.

Parametri

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    () => void

Resi

  • Promesso<void>

    Chrome 116 e versioni successive .

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre 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 facoltativo

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

      • dati

        oggetto

        I dati del messaggio.

      • da

        stringa facoltativo

        Il mittente che ha inviato il messaggio.

onMessagesDeleted

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

Attivato quando un server FCM doveva eliminare i messaggi inviati da un server di 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 era 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 facoltativo

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