Interface que representa um payload da 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 chave-valor predefinidos. As chaves aceitas são descritas abaixo.
Consulte Criar solicitações de envio para ver exemplos de código e documentação detalhada.
Assinatura:
export interface NotificationMessagePayload
Propriedades
| Propriedade | Tipo | Descrição |
|---|---|---|
| selo | string | O valor do selo no ícone do app de tela inicial.Se não for especificado, o selo não será alterado.Se definido como 0, o selo será removido.**Plataformas:** iOS |
| corpo | string | O texto do corpo da notificação.**Plataformas:** iOS, Android, Web |
| bodyLocArgs (em inglês) | string | Valores de string variáveis a serem usados no lugar dos especificadores de formato no body_loc_key para identificar o texto do corpo na localização atual do usuário.O valor precisa ser uma matriz JSON com strings.**iOS:** corresponde a loc-args no payload de APNs. Consulte Referência da chave de payload e Como localizar o conteúdo de notificações remotas para mais informações.**Android:** consulte Formatação e estilo para mais informações.**Plataformas:** iOS, Android |
| bodyLocKey (link em inglês) | string | A chave da string do corpo nos recursos de string do app a ser usada para identificar o texto do corpo na localização atual do usuário.**iOS:** corresponde a loc-key no payload de APNs. Consulte Referência da chave de payload e Como localizar o conteúdo de notificações remotas para mais informações.**Android:** consulte Recursos de string para mais informações.**Plataformas:** iOS, Android |
| clickAction. | string | Ação associada a um clique do usuário na notificação. Se especificado, uma atividade com um filtro de intent correspondente é iniciada quando um usuário clica na notificação.* **Plataformas:** Android |
| cor | string | A cor do ícone de notificação, expressa no formato #rrggbb.**Plataformas:** Android |
| ícone | string | O ícone da notificação.**Android:** define o ícone da notificação como myicon para o recurso drawable myicon. Se você não enviar essa chave na solicitação, o FCM exibirá o ícone na tela de início especificado no manifesto do app.**Web:** o URL a ser usado para o ícone da notificação.**Plataformas:** Android, Web |
| som | string | O som que será reproduzido quando o dispositivo receber uma notificação. Compatível com "default" para o som de notificação padrão do dispositivo ou o nome de arquivo de um recurso de som empacotado no app. Os arquivos de som precisam estar em /res/raw/.**Plataformas:** Android |
| marcar | string | 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 especificada e uma notificação com a mesma tag já estiver sendo exibida, a nova notificação substituirá a notificação existente na gaveta de notificações.**Plataformas:** Android |
| title | string | O título da notificação.**Plataformas:** iOS, Android, Web |
| titleLocArgs (em inglês) | string | Valores de string variáveis a serem usados no lugar dos especificadores de formato no title_loc_key para identificar o texto do título na localização atual do usuário.O valor precisa ser uma matriz JSON com strings.**iOS:** corresponde a title-loc-args no payload de APNs. Consulte Referência da chave de payload e Como localizar o conteúdo de notificações remotas para mais informações.**Android:** consulte Formatação e estilo para mais informações.**Plataformas:** iOS, Android |
| titleLocKey (link em inglês) | string | A chave da string do título nos recursos de string do app a ser usada para localizar o texto do título na localização atual do usuário.**iOS:** corresponde a title-loc-key no payload de APNs. Consulte Referência da chave de payload e Como localizar o conteúdo de notificações remotas para mais informações.**Android:** consulte Recursos de string para mais informações.**Plataformas:** iOS, Android |
NotificationMessagePayload.badge
O valor do indicador no ícone do app da tela inicial.
Se não é especificado, o indicador não é alterado.
Se for 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 para identificar o texto do corpo na localização atual do usuário.
O valor deve ser uma matriz JSON em string.
**iOS:** corresponde a loc-args no payload de APNs. Para mais informações, consulte Referência da chave de payload e Como localizar o conteúdo de notificações remotas.
**Android**: consulte Formatação e estilo para mais informações.
**Plataformas:** iOS, Android
Assinatura:
bodyLocArgs?: string;
NotificationMessagePayload.bodyLocKey
A chave da string do corpo nos recursos de string do app a ser usada para identificar o texto do corpo na localização atual do usuário.
**iOS:** corresponde a loc-key no payload de APNs. Para mais informações, consulte Referência da chave de payload e Como localizar o conteúdo de notificações remotas.
**Android**: consulte Recursos de string para 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 intent correspondente é iniciada quando um usuário clica 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 da notificação como myicon para o recurso drawable myicon. Se você não enviar essa chave na solicitação, o FCM exibirá o ícone na tela de início especificado no manifesto do app.
**Web**: o URL a ser usado para o ícone da notificação.
**Plataformas**: Android, Web
Assinatura:
icon?: string;
NotificationMessagePayload.son
O som que será reproduzido quando o dispositivo receber uma notificação. Compatível com "default" para o som de notificação padrão do dispositivo ou o nome de arquivo de um recurso de som empacotado no app. Os arquivos de som precisam estar 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 está especificado, cada solicitação cria uma nova notificação.
Se estiver especificado e uma notificação com a mesma tag já estiver sendo mostrada, a nova notificação substituirá a notificação 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 para identificar o texto do título na localização atual do usuário.
O valor deve ser uma matriz JSON em string.
**iOS:** corresponde a title-loc-args no payload de APNs. Para mais informações, consulte Referência da chave de payload e Como localizar o conteúdo de notificações remotas.
**Android**: consulte Formatação e estilo para mais informações.
**Plataformas:** iOS, Android
Assinatura:
titleLocArgs?: string;
NotificationMessagePayload.titleLocKey
A chave da string do título nos recursos de string do app a ser usada para identificar o texto do título na localização atual do usuário.
**iOS:** corresponde a title-loc-key no payload de APNs. Para mais informações, consulte Referência da chave de payload e Como localizar o conteúdo de notificações remotas.
**Android**: consulte Recursos de string para mais informações.
**Plataformas:** iOS, Android
Assinatura:
titleLocKey?: string;