NotificationMessagePayload interface

Interface que representa uma carga útil de mensagem de notificação da API legada do FCM. As mensagens de notificação permitem que os desenvolvedores enviem até 4 KB de pares de valores-chave predefinidos. As chaves aceitas estão descritas abaixo.

Consulte Build enviar solicitações para amostras de código e documentação detalhada.

Assinatura:

export interface NotificationMessagePayload 

Propriedades

NotificationMessagePayload.badge

O valor do selo no ícone do aplicativo na tela inicial.

Se não for especificado, o emblema não será alterado.

Se definido como 0 , o selo será removido.

**Plataformas:** iOS

Assinatura:

badge?: string;

NotificationMessagePayload.body

O texto do corpo da notificação.

**Plataformas:** iOS, Android, Web

Assinatura:

body?: string;

NotificationMessagePayload.bodyLocArgs

Valores de string variáveis ​​a serem usados ​​no lugar dos especificadores de formato em body_loc_key a serem usados ​​para localizar o texto do corpo para a localização atual do usuário.

O valor deve ser uma matriz JSON stringificada.

**iOS:** corresponde a loc-args na carga útil dos APNs. Consulte Referência de chave de carga útil e Localização do conteúdo de suas notificações remotas para obter mais informações.

**Android:** consulte Formatação e estilo para obter mais informações.

**Plataformas:** iOS, Android

Assinatura:

bodyLocArgs?: string;

NotificationMessagePayload.bodyLocKey

A chave para a string do corpo nos recursos de string do aplicativo a serem usados ​​para localizar o texto do corpo para a localização atual do usuário.

**iOS:** corresponde à loc-key na carga útil dos APNs. Consulte Referência de chave de carga útil e Localização do conteúdo de suas notificações remotas para obter mais informações.

**Android:** Consulte Recursos de String para obter mais informações.

**Plataformas:** iOS, Android

Assinatura:

bodyLocKey?: string;

NotificationMessagePayload.clickAction

Ação associada a um clique do usuário na notificação. Se especificado, uma atividade com um Filtro de Intenção correspondente será iniciada quando um usuário clicar na notificação.

* **Plataformas:** Android

Assinatura:

clickAction?: string;

NotificationMessagePayload.color

A cor do ícone de notificação, expressa no formato #rrggbb .

**Plataformas:** Android

Assinatura:

color?: string;

NotificationMessagePayload.icon

O ícone da notificação.

**Android:** define o ícone de notificação como myicon para o recurso drawable myicon . Se você não enviar essa chave na solicitação, o FCM exibirá o ícone do iniciador especificado no manifesto do seu aplicativo.

**Web:** O URL a ser usado para o ícone da notificação.

**Plataformas:** Android, Web

Assinatura:

icon?: string;

NotificationMessagePayload.sound

O som a ser reproduzido quando o dispositivo recebe uma notificação. Suporta "padrão" para o som de notificação padrão do dispositivo ou o nome do arquivo de um recurso de som incluído no aplicativo. Os arquivos de som devem residir em /res/raw/ .

**Plataformas:** Android

Assinatura:

sound?: string;

NotificationMessagePayload.tag

Identificador usado para substituir notificações existentes na gaveta de notificações.

Se não for especificado, cada solicitação criará uma nova notificação.

Se especificado e uma notificação com a mesma tag já estiver sendo mostrada, a nova notificação substituirá a existente na gaveta de notificações.

**Plataformas:** Android

Assinatura:

tag?: string;

NotificationMessagePayload.title

O título da notificação.

**Plataformas:** iOS, Android, Web

Assinatura:

title?: string;

NotificationMessagePayload.titleLocArgs

Valores de string variáveis ​​a serem usados ​​no lugar dos especificadores de formato em title_loc_key a serem usados ​​para localizar o texto do título para a localização atual do usuário.

O valor deve ser uma matriz JSON stringificada.

**iOS:** corresponde a title-loc-args na carga útil de APNs. Consulte Referência de chave de carga útil e Localização do conteúdo de suas notificações remotas para obter mais informações.

**Android:** consulte Formatação e estilo para obter mais informações.

**Plataformas:** iOS, Android

Assinatura:

titleLocArgs?: string;

NotificationMessagePayload.titleLocKey

A chave para a string de título nos recursos de string do aplicativo a serem usados ​​para localizar o texto do título para a localização atual do usuário.

**iOS:** corresponde à title-loc-key na carga útil dos APNs. Consulte Referência de chave de carga útil e localização do conteúdo de suas notificações remotas para obter mais informações.

**Android:** Consulte Recursos de String para obter mais informações.

**Plataformas:** iOS, Android

Assinatura:

titleLocKey?: string;