chrome.gcm

Descripción

Usa chrome.gcm para permitir que las apps y extensiones envíen y reciban mensajes a través de Firebase Cloud Messaging (FCM).

Permisos

gcm

Propiedades

MAX_MESSAGE_SIZE

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

Valor

4096

Métodos

register()

chrome.gcm.register(
  senderIds: string[],
): Promise<string>

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

Parámetros

  • senderIds

    string[]

    Es una lista de los IDs de servidor que pueden enviar mensajes a la aplicación. Debe contener al menos un ID de remitente y no más de 100.

Muestra

  • Promise<string>

    Chrome 116 y versiones posteriores

send()

chrome.gcm.send(
  message: object,
): Promise<string>

Envía un mensaje según su contenido.

Parámetros

  • mensaje

    objeto

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

    • datos

      objeto

      Son los datos del mensaje que se enviarán al servidor. No se permiten goog. y google que no distinguen entre mayúsculas y minúsculas, ni collapse_key que sí lo hace, como prefijos de claves. La suma de todos los pares clave-valor no debe superar gcm.MAX_MESSAGE_SIZE.

    • destinationId

      string

      Es el ID del servidor al que se enviará el mensaje, según lo asignado por la Consola de API de Google.

    • messageId

      string

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

    • timeToLive

      número opcional

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

Muestra

  • Promise<string>

    Chrome 116 y versiones posteriores

unregister()

chrome.gcm.unregister(): Promise<void>

Cancela el registro de la aplicación en FCM.

Muestra

  • Promise<void>

    Chrome 116 y versiones posteriores

Eventos

onMessage

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

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

Parámetros

  • callback

    función

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

    (message: object) => void

    • mensaje

      objeto

      • collapseKey

        cadena opcional

        Es la clave de contracción de un mensaje. Para obtener más información, consulta Mensajes contraíbles y no contraíbles.

      • datos

        objeto

        Son los datos del mensaje.

      • de

        cadena opcional

        Es el remitente que emitió el mensaje.

onMessagesDeleted

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

Se activa cuando un servidor de FCM debe borrar mensajes que un servidor de apps envió a la aplicación. Consulta Duración de un mensaje para obtener detalles sobre el control de este evento.

Parámetros

  • callback

    función

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

    () => void

onSendError

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

Se activa cuando no se pudo enviar un mensaje al servidor de FCM.

Parámetros

  • callback

    función

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

    (error: object) => void

    • error

      objeto

      • detalles

        objeto

        Son detalles adicionales relacionados con el error, cuando están disponibles.

      • errorMessage

        string

        Es el mensaje de error que describe el problema.

      • messageId

        cadena opcional

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