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 Solicitudes de envío de compilación para obtener ejemplos de código y documentación detallada.

Firma:

export interface NotificationMessagePayload 

Propiedades

Propiedad Tipo Descripción
insignia cadena El valor de la insignia en el ícono 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 cadena El texto del cuerpo de la notificación. **Plataformas:** iOS, Android, Web
cuerpoLocArgs cadena Valores de cadena variables que se utilizarán en lugar de los especificadores de formato en body_loc_key para localizar el texto del cuerpo a la localización actual del usuario. El valor debe ser una matriz JSON encadenada. **iOS:** Corresponde a loc-args en la carga útil de APN. Consulte Referencia 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
cuerpoLocKey cadena 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 a la localización actual del usuario. **iOS:** Corresponde a la loc-key en la carga útil de APN. Consulte Referencia 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 cadena Acción asociada a que un usuario haga clic 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 cadena El color del icono de notificación, expresado en formato #rrggbb . **Plataformas:** Android
icono cadena El icono de notificación. **Android:** Establece el ícono de notificación en myicon para el recurso dibujable myicon . Si no envía esta clave en la solicitud, FCM muestra el icono del iniciador especificado en el manifiesto de su aplicación. **Web:** La URL que se utilizará para el ícono de notificación. **Plataformas:** Android, Web
sonido cadena 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 cadena Identificador utilizado para reemplazar 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 la existente en el cajón de notificaciones. **Plataformas:** Android
título cadena El título de la notificación. **Plataformas:** iOS, Android, Web
títuloLocArgs cadena 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 a la localización actual del usuario. El valor debe ser una matriz JSON encadenada. **iOS:** Corresponde a title-loc-args en la carga útil de APN. Consulte Referencia 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
títuloLocKey cadena 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 a la localización actual del usuario. **iOS:** Corresponde a title-loc-key en la carga útil de APN. Consulte Referencia 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

NotificaciónMensajePayload.badge

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

Si no se especifica, la insignia no se cambia.

Si se establece en 0 , se retira la insignia.

**Plataformas:** iOS

Firma:

badge?: string;

NotificaciónMensajePayload.body

El texto del cuerpo de la notificación.

**Plataformas:** iOS, Android, Web

Firma:

body?: string;

NotificaciónMessagePayload.bodyLocArgs

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

El valor debe ser una matriz JSON encadenada.

**iOS:** Corresponde a loc-args en la carga útil de APN. Consulte Referencia 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;

NotificaciónMessagePayload.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 a la localización actual del usuario.

**iOS:** Corresponde a la loc-key en la carga útil de APN. Consulte Referencia 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;

NotificaciónMessagePayload.clickAction

Acción asociada a que un usuario haga clic 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;

NotificaciónMensajePayload.color

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

**Plataformas:** Android

Firma:

color?: string;

NotificaciónMensajePayload.icon

El icono de notificación.

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

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

**Plataformas:** Android, Web

Firma:

icon?: string;

NotificaciónMensajePayload.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;

NotificaciónMessagePayload.tag

Identificador utilizado para reemplazar 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 la existente en el cajón de notificaciones.

**Plataformas:** Android

Firma:

tag?: string;

NotificaciónMessagePayload.título

El título de la notificación.

**Plataformas:** iOS, Android, Web

Firma:

title?: string;

NotificaciónMessagePayload.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 a la localización actual del usuario.

El valor debe ser una matriz JSON encadenada.

**iOS:** Corresponde a title-loc-args en la carga útil de APN. Consulte Referencia 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;

NotificaciónMessagePayload.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 a la localización actual del usuario.

**iOS:** Corresponde a title-loc-key en la carga útil de APN. Consulte Referencia 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;