chrome.gcm

Descrizione

Utilizza chrome.gcm per abilitare app ed estensioni all'invio e alla ricezione di 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,
)

Registra l'applicazione con FCM. L'ID di registrazione verrà restituito dal callback. Se register viene richiamato di nuovo 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 un minimo di 1 e un massimo 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.

Ritorni

  • Promessa<string>

    Chrome 116 e versioni successive

    Le promesse sono supportate in Manifest V3 e versioni successive, ma vengono forniti callback per garantire la compatibilità con le versioni precedenti. Non puoi utilizzarli entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo trasmesso al callback.

send()

Promessa 
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 caratteri goog. e google senza distinzione tra maiuscole e minuscole e i valori collapse_key sensibili alle maiuscole non sono consentiti come prefissi delle chiavi. 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 assegnato dalla console API di Google.

    • messageId

      stringa

      L'ID del messaggio. Deve essere univoco per ogni messaggio nell'ambito delle applicazioni. Per consigli sulla scelta e la gestione di un documento di identità, 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, verrà generato un evento onSendError. Una durata pari a 0 indica che il messaggio deve essere inviato immediatamente o avere esito negativo se non è possibile. Il valore predefinito della durata è 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.

Ritorni

  • Promessa<string>

    Chrome 116 e versioni successive

    Le promesse sono supportate in Manifest V3 e versioni successive, ma vengono forniti callback per garantire la compatibilità con le versioni precedenti. Non puoi utilizzarli entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo trasmesso al callback.

unregister()

Promessa 
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

Ritorni

  • Promise<void>

    Chrome 116 e versioni successive

    Le promesse sono supportate in Manifest V3 e versioni successive, ma vengono forniti callback per garantire la compatibilità con le versioni precedenti. Non puoi utilizzarli entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo trasmesso al 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 i 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 ha dovuto eliminare i messaggi inviati da un server di app all'applicazione. Per maggiori dettagli sulla gestione di questo evento, vedi 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 facoltativo

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