NotificationMessagePayload interface

Interfaz que representa la carga útil de un mensaje de notificación de la API heredada de FCM. Los mensajes de notificación permiten a los desarrolladores enviar hasta 4 KB de pares clave-valor predefinidos. Las claves aceptadas se describen a continuación.

Consulta Cómo compilar solicitudes de envío para ver muestras de código y documentación detallada.

Firma:

export interface NotificationMessagePayload 

Propiedades

NotificationMessagePayload.Badge

El valor de la insignia en el ícono de la app de la pantalla principal.

Si no se especifica, no se cambia la insignia.

Si se le asigna el valor 0, la insignia se quita.

**Plataformas:** iOS

Firma:

badge?: string;

NotificationMessagePayload.body

El texto del cuerpo de la notificación.

**Plataformas:** iOS, Android y Web

Firma:

body?: string;

NotificationMessagePayload.bodyLocArgs

Valores de cadena variables que se usarán en lugar de los especificadores de formato en body_loc_key para localizar el cuerpo del texto en la localización actual del usuario.

El valor debe ser un array JSON en cadena.

**iOS:** Corresponde a loc-args en la carga útil de APNS. Para obtener más información, consulta Referencia de la clave de carga útil y Cómo localizar el contenido de las notificaciones remotas.

**Android:** Consulta Formato y estilo para obtener más información.

**Plataformas:** iOS y Android

Firma:

bodyLocArgs?: string;

NotificationMessagePayload.bodyLocKey

La clave de la cadena del cuerpo en los recursos de cadenas de la app que se usa para localizar el texto del cuerpo en la localización actual del usuario.

**iOS:** Corresponde a loc-key en la carga útil de APNS. Para obtener más información, consulta Referencia de la clave de carga útil y Cómo localizar el contenido de las notificaciones remotas.

**Android:** Consulta Recursos de strings para obtener más información.

**Plataformas:** iOS y Android

Firma:

bodyLocKey?: string;

NotificationMessagePayload.clickAction

La acción asociada con el clic de un usuario en la notificación. Si se especifica, se lanza una actividad con un filtro de intents que coincide cuando un usuario hace clic en la notificación.

* **Plataformas:** Android

Firma:

clickAction?: string;

NotificationMessagePayload.color

El color del ícono de notificación, expresado en formato #rrggbb.

**Plataformas:** Android

Firma:

color?: string;

NotificationMessagePayload.icon

El ícono de la notificación.

**Android:** Establece el ícono de notificación en myicon para el recurso de elementos de diseño myicon. Si no envías esta clave en la solicitud, FCM muestra el ícono de selector especificado en el manifiesto de la app.

**Web:** La URL que se usará para el ícono de la notificación.

**Plataformas:** Android y la Web

Firma:

icon?: string;

NotificationMessagePayload.sonido

El sonido que se reproducirá cuando el dispositivo reciba una notificación. Admite la configuración predeterminada para el sonido de notificación predeterminado del dispositivo o el nombre de archivo de un recurso de sonido incluido en la app. Los archivos de sonido deben encontrarse en /res/raw/.

**Plataformas:** Android

Firma:

sound?: string;

NotificationMessagePayload.tag

Identificador que se usa para reemplazar las notificaciones existentes en el panel lateral de notificaciones.

Si no se configura, cada solicitud crea una nueva notificación.

Si se especifica y ya se muestra una notificación con la misma etiqueta, la nueva notificación reemplaza la existente en el panel lateral de notificaciones.

**Plataformas:** Android

Firma:

tag?: string;

NotificationMessagePayload.title

El título de la notificación.

**Plataformas:** iOS, Android y Web

Firma:

title?: string;

NotificationMessagePayload.titleLocArgs

Valores de cadena variables que se usarán en lugar de los especificadores de formato en title_loc_key para localizar el título del texto en la localización actual del usuario.

El valor debe ser un array JSON en cadena.

**iOS:** Corresponde a title-loc-args en la carga útil de APNS. Para obtener más información, consulta Referencia de la clave de carga útil y Cómo localizar el contenido de las notificaciones remotas.

**Android:** Consulta Formato y estilo para obtener más información.

**Plataformas:** iOS y Android

Firma:

titleLocArgs?: string;

NotificationMessagePayload.titleLocKey

La clave de la cadena del título en los recursos de cadenas de la app que se usa para localizar el texto del título según la localización actual del usuario.

**iOS:** Corresponde a title-loc-key en la carga útil de APNS. Para obtener más información, consulta Referencia de la clave de carga útil y Cómo localizar el contenido de las notificaciones remotas.

**Android:** Consulta Recursos de strings para obtener más información.

**Plataformas:** iOS y Android

Firma:

titleLocKey?: string;