NotificationMessagePayload interface

Interfaz que representa una carga útil de mensaje de notificación de 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.

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

Firma:

export interface NotificationMessagePayload 

Propiedades

Propiedad Escribe Descripción
Insignia cuerda El valor de la insignia en el icono de la aplicación de la pantalla de inicio. Si no se especifica, la insignia no se cambia. Si se establece en 0 , se elimina la insignia. **Plataformas:** iOS
cuerpo cuerda El texto del cuerpo de la notificación. **Plataformas:** iOS, Android, Web
cuerpoLocArgs cuerda Valores de cadena variables que se usarán en lugar de los especificadores de formato en body_loc_key para localizar el texto del cuerpo en la ubicación actual del usuario. El valor debe ser una matriz JSON en cadena. **iOS:** corresponde a loc-args en la carga útil de APN. Consulte Referencia de clave de carga útil y Localización del contenido de sus notificaciones remotas para obtener más información. **Android:** Consulte Formato y estilo para obtener más información. **Plataformas:** iOS, Android
bodyLocKey cuerda La clave de la cadena del cuerpo en los recursos de cadena de la aplicación que se usará para localizar el texto del cuerpo en la localización actual del usuario. **iOS:** corresponde a loc-key de bloqueo en la carga útil de APN. Consulte Referencia de clave de carga útil y Localización del contenido de sus notificaciones remotas para obtener más información. **Android:** Consulte Recursos de cadenas para obtener más información. **Plataformas:** iOS, Android
hacer clic en Acción cuerda Acción asociada a un clic de usuario en la notificación. Si se especifica, se inicia una actividad con un filtro de intención coincidente cuando un usuario hace clic en la notificación. * **Plataformas:** Android
color cuerda El color del icono de notificación, expresado en formato #rrggbb . **Plataformas:** Android
icono cuerda El icono de la notificación. **Android:** Establece el ícono de notificación en myicon para myicon de recurso myicon . Si no envía esta clave en la solicitud, FCM muestra el ícono del iniciador especificado en el manifiesto de su aplicación. **Web:** La URL que se usará para el icono de la notificación. **Plataformas:** Android, Web
sonido cuerda El sonido que se reproducirá cuando el dispositivo reciba una notificación. Admite "predeterminado" para el sonido de notificación predeterminado del dispositivo o el nombre de archivo de un recurso de sonido incluido en la aplicación. Los archivos de sonido deben residir en /res/raw/ . **Plataformas:** Android
etiqueta cuerda Identificador utilizado para reemplazar las notificaciones existentes en el cajón de notificaciones. Si no se especifica, 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 a la existente en el cajón de notificaciones. **Plataformas:** Android
título cuerda El título de la notificación. **Plataformas:** iOS, Android, Web
titleLocArgs cuerda Valores de cadena variables que se utilizarán en lugar de los especificadores de formato en title_loc_key para localizar el texto del título en la localización actual del usuario. El valor debe ser una matriz JSON en cadena. **iOS:** corresponde a title-loc-args en la carga útil de APN. Consulte Referencia de clave de carga útil y Localización del contenido de sus notificaciones remotas para obtener más información. **Android:** Consulte Formato y estilo para obtener más información. **Plataformas:** iOS, Android
titleLocKey cuerda La clave de la cadena de título en los recursos de cadena de la aplicación que se usará para localizar el texto del título en la localización actual del usuario. **iOS:** corresponde a title-loc-key en la carga útil de APN. Consulte Referencia de clave de carga útil y Localización del contenido de sus notificaciones remotas para obtener más información. **Android:** Consulte Recursos de cadenas para obtener más información. **Plataformas:** iOS, Android

NotificationMessagePayload.badge

El valor de la insignia en el icono de la aplicación de la pantalla de inicio.

Si no se especifica, la insignia no se cambia.

Si se establece en 0 , se elimina la insignia.

**Plataformas:** iOS

Firma:

badge?: string;

NotificationMessagePayload.body

El texto del cuerpo de la notificación.

**Plataformas:** iOS, Android, 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 texto del cuerpo en la ubicación actual del usuario.

El valor debe ser una matriz JSON en cadena.

**iOS:** corresponde a loc-args en la carga útil de APN. Consulte Referencia de clave de carga útil y Localización del contenido de sus notificaciones remotas para obtener más información.

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

**Plataformas:** iOS, Android

Firma:

bodyLocArgs?: string;

NotificationMessagePayload.bodyLocKey

La clave de la cadena del cuerpo en los recursos de cadena de la aplicación que se usará para localizar el texto del cuerpo en la localización actual del usuario.

**iOS:** corresponde a loc-key de bloqueo en la carga útil de APN. Consulte Referencia de clave de carga útil y Localización del contenido de sus notificaciones remotas para obtener más información.

**Android:** Consulte Recursos de cadenas para obtener más información.

**Plataformas:** iOS, Android

Firma:

bodyLocKey?: string;

NotificationMessagePayload.clickAcción

Acción asociada a un clic de usuario en la notificación. Si se especifica, se inicia una actividad con un filtro de intención coincidente cuando un usuario hace clic en la notificación.

* **Plataformas:** Android

Firma:

clickAction?: string;

NotificationMessagePayload.color

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

**Plataformas:** Android

Firma:

color?: string;

NotificationMessagePayload.icon

El icono de la notificación.

**Android:** Establece el ícono de notificación en myicon para el recurso myicon . Si no envía esta clave en la solicitud, FCM muestra el ícono del iniciador especificado en el manifiesto de su aplicación.

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

**Plataformas:** Android, Web

Firma:

icon?: string;

NotificationMessagePayload.sound

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

**Plataformas:** Android

Firma:

sound?: string;

NotificationMessagePayload.tag

Identificador utilizado para reemplazar las notificaciones existentes en el cajón de notificaciones.

Si no se especifica, 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 a la existente en el cajón de notificaciones.

**Plataformas:** Android

Firma:

tag?: string;

NotificationMessagePayload.título

El título de la notificación.

**Plataformas:** iOS, Android, Web

Firma:

title?: string;

NotificationMessagePayload.titleLocArgs

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

El valor debe ser una matriz JSON en cadena.

**iOS:** corresponde a title-loc-args en la carga útil de APN. Consulte Referencia de clave de carga útil y Localización del contenido de sus notificaciones remotas para obtener más información.

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

**Plataformas:** iOS, Android

Firma:

titleLocArgs?: string;

NotificationMessagePayload.titleLocKey

La clave de la cadena de título en los recursos de cadena de la aplicación que se usará para localizar el texto del título en la localización actual del usuario.

**iOS:** corresponde a title-loc-key en la carga útil de APN. Consulte Referencia de clave de carga útil y Localización del contenido de sus notificaciones remotas para obtener más información.

**Android:** Consulte Recursos de cadenas para obtener más información.

**Plataformas:** iOS, Android

Firma:

titleLocKey?: string;