chrome.gcm

Descripción

Usa chrome.gcm para habilitar apps y extensiones a fin de 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

4,096

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[]

  Una lista de los ID de los servidores que tienen permitido enviar mensajes a la aplicación. Debe contener como mínimo 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

    string

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

Muestra

• Promesa<string>

  Chrome 116 y versiones posteriores

  Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

send()

Promesa

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

Envía un mensaje según su contenido.

Parámetros

• mensaje

  objeto

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

  • datos

    objeto

    Datos del mensaje para enviar al servidor. No se permiten goog. y google que no distinguen mayúsculas de minúsculas, ni collapse_key que distingue 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

    string

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

  • messageId

    string

    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 consejos sobre cómo elegir y administrar un ID.

  • timeToLive

    número opcional

    Tiempo de vida del mensaje en segundos. Si no es posible enviar el mensaje en ese tiempo, 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 86,400 segundos (1 día) y el valor máximo es 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

    string

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

Muestra

• Promesa<string>

  Chrome 116 y versiones posteriores

  Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones 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

Muestra

• Promesa<void>

  Chrome 116 y versiones posteriores

  Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones 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

  función

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

  (message: object) => void

  • mensaje

    objeto

    • collapseKey

      string opcional

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

    • datos

      objeto

      Los datos del mensaje

    • de

      string 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 enviados por un servidor de apps a la aplicación. Consulta Duración de un mensaje para obtener detalles sobre cómo controlar 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 es posible 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

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

    • errorMessage

      string

      Es el mensaje de error que describe el problema.

    • messageId

      string opcional

      El ID del mensaje con este error, si este se relaciona con un mensaje específico.