browser.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 de un mensaje.

Valor

4096

Métodos

register()

browser.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 IDs de servidor que tienen permiso para 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 browser.* desde Chrome 148

  Se resuelve cuando se completa el registro.

send()

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

Envía un mensaje según su contenido.

Parámetros

• mensaje

  objeto

  Es un mensaje que se envía 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 los prefijos de clave goog. y google que no distinguen mayúsculas de minúsculas, ni collapse_key que sí las distingue. La suma de todos los pares clave-valor no debe superar los 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 APIs de Google.

  • messageId

    string

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

  • timeToLive

    number opcional

    Es el tiempo de actividad del mensaje en segundos. Si no es posible enviar el mensaje dentro de ese período, 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 actividad 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 browser.* desde Chrome 148

  Se resuelve después de que el mensaje se pone en cola correctamente para su envío. Si se produce un error, se rechazará la promesa.

unregister()

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

Cancela el registro de la aplicación en FCM.

Muestra

• Promise<void>

  Chrome 116 y versiones posteriores browser.* desde Chrome 148

  Se resuelve después de que se completa la cancelación del registro. La cancelación del registro se realizó correctamente si no se rechaza la promesa.

Eventos

onMessage

browser.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

      Es la clave de contracción de un mensaje. Consulta Mensajes contraíbles y no contraíbles para obtener más detalles.

    • datos

      objeto

      Son los datos del mensaje.

    • de

      string opcional

      Es el remitente que emitió el mensaje.

onMessagesDeleted

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

Se activa cuando un servidor de FCM tuvo que borrar mensajes enviados por un servidor de apps a la aplicación. Consulta la 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

browser.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

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