MessagingOptions interface

Interfaz que representa las opciones que se pueden proporcionar al enviar un mensaje a través de las API heredadas de FCM.

Consulte Solicitudes de envío de compilación para obtener ejemplos de código y documentación detallada.

Firma:

export interface MessagingOptions 

Propiedades

Opciones de mensajería.collapseKey

Cadena que identifica un grupo de mensajes (por ejemplo, "Actualizaciones disponibles") que se pueden contraer, de modo que solo se envíe el último mensaje cuando se pueda reanudar la entrega. Esto se utiliza para evitar enviar demasiados mensajes iguales cuando el dispositivo vuelve a conectarse o se activa.

No hay garantía del orden en que se envían los mensajes.

Se permite un máximo de cuatro claves de colapso diferentes en un momento dado. Esto significa que el servidor FCM puede almacenar simultáneamente cuatro mensajes de envío para sincronización diferentes por aplicación cliente. Si excede este número, no hay garantía de qué cuatro claves de colapso conservará el servidor FCM.

**Valor predeterminado:** Ninguno

Firma:

collapseKey?: string;

Opciones de mensajería.contentAvailable

En iOS, utilice este campo para representar content-available en la carga útil de APN. Cuando se envía una notificación o mensaje de datos y esto se establece en true , se activa una aplicación cliente inactiva. En Android, los mensajes de datos activan la aplicación de forma predeterminada. En Chrome, esta bandera no es compatible actualmente.

**Valor predeterminado:** false

Firma:

contentAvailable?: boolean;

Opciones de mensajería.dryRun

Si el mensaje realmente debe enviarse o no. Cuando se establece en true , permite a los desarrolladores probar una solicitud sin enviar un mensaje. Cuando se establece en false , el mensaje será enviado.

**Valor predeterminado:** false

Firma:

dryRun?: boolean;

Opciones de mensajería.mutableContent

En iOS, utilice este campo para representar mutable-content en la carga útil de APN. Cuando se envía una notificación y esto se establece en true , el contenido de la notificación se puede modificar antes de que se muestre, utilizando una extensión de la aplicación del Servicio de notificaciones .

En Android y Web, este parámetro se ignorará.

**Valor predeterminado:** false

Firma:

mutableContent?: boolean;

Opciones de mensajería.prioridad

La prioridad del mensaje. Los valores válidos son "normal" y "high". En iOS, estos corresponden a las prioridades 5 y 10 de APN. .

De forma predeterminada, los mensajes de notificación se envían con prioridad alta y los mensajes de datos con prioridad normal. La prioridad normal optimiza el consumo de batería de la aplicación cliente y debe usarse a menos que se requiera una entrega inmediata. Para mensajes con prioridad normal, la aplicación puede recibir el mensaje con un retraso no especificado.

Cuando se envía un mensaje con alta prioridad, se envía inmediatamente y la aplicación puede activar un dispositivo inactivo y abrir una conexión de red a su servidor.

Para obtener más información, consulte Configuración de la prioridad de un mensaje. .

**Valor predeterminado:** "high" para mensajes de notificación, "normal" para mensajes de datos

Firma:

priority?: string;

Opciones de mensajería.nombredepaqueterestringido

El nombre del paquete de la aplicación con el que deben coincidir los tokens de registro para recibir el mensaje.

**Valor predeterminado:** Ninguno

Firma:

restrictedPackageName?: string;

Opciones de mensajería.timeToLive

Cuánto tiempo (en segundos) debe mantenerse el mensaje en el almacenamiento de FCM si el dispositivo está fuera de línea. El tiempo de vida máximo admitido es de cuatro semanas y el valor predeterminado también es de cuatro semanas. Para obtener más información, consulte Configuración de la vida útil de un mensaje. .

**Valor predeterminado:** 2419200 (que representa cuatro semanas, en segundos)

Firma:

timeToLive?: number;