Interfaz que representa las opciones que se pueden proporcionar al enviar un mensaje a través de las APIs heredadas de FCM.
Consulta Cómo compilar solicitudes de envío para ver muestras de código y documentación detallada.
Firma:
export interface MessagingOptions
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
| contraerKey | string | Cadena que identifica un grupo de mensajes (por ejemplo, "Actualizaciones disponibles") que se pueden contraer para que solo se envíe el último mensaje cuando se reanude la entrega. Esto se utiliza para evitar que se envíen demasiados mensajes iguales cuando el dispositivo se vuelve a conectar o se activa.No se puede garantizar el orden en el que se envían los mensajes.Se permite un máximo de cuatro claves de contracción diferentes en cualquier momento. Esto significa que el servidor de FCM puede almacenar simultáneamente cuatro mensajes send-to-sync diferentes por app cliente. Si superas esta cantidad, no hay garantía de cuáles son las cuatro claves de contracción que conservará el servidor de FCM.**Valor predeterminado:** Ninguna |
| contenido disponible | booleano | En iOS, usa este campo para representar content-available en la carga útil de APNS. Cuando se envía una notificación o un mensaje de datos y el valor del campo es true, se despierta una app cliente inactiva. En Android, los mensajes de datos activan la app de forma predeterminada. En Chrome, esta marca no se admite actualmente.**Valor predeterminado:** false |
| dryRun | booleano | Indica si el mensaje se debe enviar o no. Cuando se establece en true, permite que los desarrolladores prueben una solicitud sin enviar realmente un mensaje. Cuando la estableces como false, se enviará el mensaje.**Valor predeterminado:** false |
| contenidodemutable | booleano | En iOS, usa este campo para representar mutable-content en la carga útil de APNS. Cuando se envía una notificación y el valor del campo es true, el contenido de la notificación se puede modificar antes de mostrarse mediante una extensión de aplicación del servicio de notificaciones.En Android y en la Web, se ignorará este parámetro.**Valor predeterminado:** false |
| prioridad | string | Es la prioridad del mensaje. Los valores válidos son "normal" y "high".. En iOS, estos corresponden a las prioridades de APNS 5 y 10.De forma predeterminada, los mensajes de notificación se envían con prioridad alta y los mensajes de datos se envían con prioridad normal. La prioridad normal optimiza el consumo de batería de la app cliente y debe usarse salvo que se requiera una entrega inmediata. En el caso de los mensajes con prioridad normal, la app podría recibirlos con una demora no especificada.Cuando un mensaje se envía con prioridad alta, se envía inmediatamente y la app puede activar un dispositivo suspendido y abrir una conexión de red a tu servidor.Para obtener más información, consulta Cómo configurar la prioridad de un mensaje.**Valor predeterminado:** "high" para mensajes de notificación, "normal" para mensajes de datos |
| restrictedPackageName | string | El nombre del paquete de la aplicación con el que los tokens de registro deben coincidir para recibir el mensaje.**Valor predeterminado:** Ninguno |
| tiempo de actividad | número | Cuánto tiempo (en segundos) se debe guardar el mensaje en el almacenamiento de FCM si el dispositivo está sin conexión. 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, consulta Cómo configurar la duración de un mensaje.**Valor predeterminado:** 2419200 (que representa cuatro semanas, en segundos) |
MensajeríaOptions.contraerKey
Cadena que identifica un grupo de mensajes (por ejemplo, "Actualizaciones disponibles") que se pueden contraer para que solo se envíe el último mensaje cuando se reanude la entrega. Se usa para evitar que se envíen demasiados de los mismos mensajes cuando el dispositivo se vuelve a conectar o se activa.
No se puede garantizar el orden en que se envían los mensajes.
Se permite un máximo de cuatro claves de contracción diferentes en cualquier momento. Esto significa que el servidor de FCM puede almacenar simultáneamente cuatro mensajes send-to-sync diferentes por app cliente. Si superas esta cantidad, no hay garantía de cuáles son las cuatro claves de contracción que conservará el servidor de FCM.
**Valor predeterminado:** Ninguno
Firma:
collapseKey?: string;
MessagingOptions.contentAvailable
En iOS, usa este campo para representar content-available en la carga útil de APNS. Cuando se envía una notificación o un mensaje de datos y el valor del campo es true, se despierta una app cliente inactiva. En Android, los mensajes de datos activan la app de forma predeterminada. En Chrome, esta función no se admite actualmente.
**Valor predeterminado:** false
Firma:
contentAvailable?: boolean;
MessagingOptions.dryRun
Indica si el mensaje se debe enviar o no. Cuando se establece en true, permite que los desarrolladores prueben una solicitud sin enviar realmente un mensaje. Cuando se establece en false, el mensaje se enviará.
**Valor predeterminado:** false
Firma:
dryRun?: boolean;
MessagingOptions.mutableContent
En iOS, usa este campo para representar mutable-content en la carga útil de APNS. Cuando se envía una notificación y el valor de este parámetro es true, el contenido de la notificación se puede modificar antes de mostrarse mediante una extensión de app del servicio de notificaciones.
En Android y la Web, se ignorará este parámetro.
**Valor predeterminado:** false
Firma:
mutableContent?: boolean;
MessagingOptions.priority
Es la prioridad del mensaje. Los valores válidos son "normal" y "high".. En iOS, estos corresponden a las prioridades de APNS 5 y 10.
De forma predeterminada, los mensajes de notificación se envían con prioridad alta y los mensajes de datos se envían con prioridad normal. La prioridad normal optimiza el consumo de batería de la app cliente y debe usarse salvo que se requiera una entrega inmediata. Para los mensajes con prioridad normal, la app puede recibir el mensaje con una demora no especificada.
Cuando un mensaje se envía con prioridad alta, se envía inmediatamente y la app puede activar un dispositivo suspendido y abrir una conexión de red a tu servidor.
Para obtener más información, consulta Cómo configurar la prioridad de un mensaje.
**Valor predeterminado:** "high" para mensajes de notificación, "normal" para mensajes de datos
Firma:
priority?: string;
MessagingOptions.restrictedPackageName
El nombre del paquete de la aplicación con el que los tokens de registro deben hacer coincidir para recibir el mensaje.
**Valor predeterminado:** Ninguno
Firma:
restrictedPackageName?: string;
MessagingOptions.timeToLive
Cuánto tiempo (en segundos) se debe guardar el mensaje en el almacenamiento de FCM si el dispositivo está sin conexión. 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, consulta Cómo configurar la duración de un mensaje.
**Valor predeterminado:** 2419200 (que representa cuatro semanas, en segundos)
Firma:
timeToLive?: number;