chrome.gcm

Descripción

Usa chrome.gcm a fin de habilitar apps y extensiones para enviar y recibir mensajes a través de Firebase Cloud Messaging (FCM).

Permisos

gcm

Propiedades

MAX_MESSAGE_SIZE

El tamaño máximo (en bytes) de todos los pares clave-valor en un mensaje.

Valor

4096

Métodos

register()

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

Registra la aplicación con FCM. callback mostrará el ID de registro. Si se vuelve a llamar a register con la misma lista de senderIds, se mostrará el mismo ID de registro.

Parámetros

  • senderIds

    string[]

    Es una lista de los ID de los servidores autorizados para enviar mensajes a la aplicación. Debe contener al menos un ID de remitente y no más de 100.

  • callback

    Función opcional

    El parámetro callback se ve de la siguiente manera: 

    (registrationId: string)=>void

    • registrationId

      cadena

      Un ID de registro que FCM asigna a la aplicación.

Devuelve

  • Promesa<string>

    Chrome 116 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

send()

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

Envía un mensaje según su contenido.

Parámetros

  • message

    objeto

    Un mensaje para enviar a la otra parte a través de FCM.

    • datos

      objeto

      Datos de mensajes para enviar al servidor. No se permiten goog. y google, ni collapse_key, que no distinguen mayúsculas de minúsculas, como prefijos de clave. La suma de todos los pares clave-valor no debe exceder gcm.MAX_MESSAGE_SIZE.

    • destinationId

      cadena

      Es el ID del servidor al que se enviará el mensaje, tal como lo asigna la Consola de APIs de Google.

    • messageId

      cadena

      El ID del mensaje. Debe ser única para cada mensaje dentro del alcance de las aplicaciones. Consulta la documentación de Cloud Messaging para obtener consejos sobre cómo elegir y controlar un ID.

    • timeToLive

      número opcional

      Tiempo de actividad del mensaje en segundos. Si no es posible enviar el mensaje en ese plazo, se generará un evento onSendError. Un tiempo de actividad de 0 indica que el mensaje debe enviarse de inmediato o fallar si no es posible. El valor predeterminado del tiempo de actividad es de 86,400 segundos (1 día) y el valor máximo es de 2,419,200 segundos (28 días).

  • callback

    Función opcional

    El parámetro callback se ve de la siguiente manera: 

    (messageId: string)=>void

    • messageId

      cadena

      El ID del mensaje para el que se emitió la devolución de llamada.

Devuelve

  • Promesa<string>

    Chrome 116 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

unregister()

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

Cancela el registro de la aplicación en FCM.

Parámetros

  • callback

    Función opcional

    El parámetro callback se ve de la siguiente manera: 

    ()=>void

Devuelve

  • Promise<void>

    Chrome 116 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

Eventos

onMessage

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

Se activa cuando se recibe un mensaje a través de FCM.

Parámetros

  • callback

    la función

    El parámetro callback se ve de la siguiente manera: 

    (message: object)=>void

    • message

      objeto

      • collapseKey

        cadena opcional

        La tecla para contraer de un mensaje. Consulta los mensajes contraíbles y no contraíbles para obtener más detalles.

      • datos

        objeto

        Los datos del mensaje

      • de

        cadena opcional

        El remitente que emitió el mensaje.

onMessagesDeleted

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

Se activa cuando un servidor de FCM tiene que borrar mensajes que un servidor de apps envía a la aplicación. Consulta Ciclo de vida de un mensaje para obtener detalles sobre el control de este evento.

Parámetros

  • callback

    la función

    El parámetro callback se ve de la siguiente manera: 

    ()=>void

onSendError

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

Se activa cuando no es posible enviar un mensaje al servidor de FCM.

Parámetros

  • callback

    la función

    El parámetro callback se ve de la siguiente manera: 

    (error: object)=>void

    • error

      objeto

      • detalles

        objeto

        Detalles adicionales relacionados con el error, cuando estén disponibles.

      • errorMessage

        cadena

        Es el mensaje de error que describe el problema.

      • messageId

        cadena opcional

        El ID del mensaje con este error, si el error está relacionado con un mensaje específico.