Representa as opções de notificação específicas do Android que podem ser incluídas em AndroidConfig.
Assinatura:
export interface AndroidNotification
Propriedades
| Propriedade | Tipo | Descrição |
|---|---|---|
| corpo | string | Corpo da notificação do Android. Quando fornecido, substitui o corpo definido por admin.messaging.Notification. |
| bodyLocArgs (em inglês) | string[] | Uma matriz de chaves de recurso que serão usadas no lugar dos especificadores de formato em bodyLocKey. |
| bodyLocKey (link em inglês) | string | Chave da string do corpo no recurso de string do app a ser usada para localizar o texto do corpo. |
| channelId | string | O ID do canal de notificação do Android (novo no Android O). O app precisa criar um canal com este ID do canal para que qualquer notificação com ele seja recebida. Se você não enviar esse ID do canal na solicitação ou se o ID do canal fornecido ainda não tiver sido criado pelo app, o FCM usará o ID do canal especificado no manifesto do app. |
| 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. |
| cor | string | Cor do ícone de notificação no formato #rrggbb. |
| defaultLightSettings (em inglês). | booleano | Se definida como true, use as configurações de luz de LED padrão do framework do Android para a notificação. Os valores padrão são especificados em config.xml. Se default_light_settings for definido como true e light_settings também for definido, o light_settings especificado pelo usuário será usado no lugar do valor padrão. |
| defaultSound (em inglês) | booleano | Se definido como true, use o som padrão do framework do Android para a notificação. Os valores padrão são especificados em config.xml. |
| defaultVibrateTimings (em inglês) | booleano | Se definido como true, use o padrão de vibração padrão do framework do Android para a notificação. Os valores padrão são especificados em config.xml. Se default_vibrate_timings for definido como true e vibrate_timings também for definido, o valor padrão será usado em vez do vibrate_timings especificado pelo usuário. |
| eventTimestamp. | Data | Para notificações que informam os usuários sobre eventos com uma referência de tempo absoluto, define a hora em que o evento na notificação ocorreu. As notificações no painel são classificadas por esse horário. |
| ícone | string | Recurso de ícone para a notificação do Android. |
| imageUrl (link em inglês) | string | URL de uma imagem a ser exibido na notificação. |
| lightSettings (link em inglês) | LightSettings (em inglês) | Configurações para controlar a taxa de piscar e a cor do LED da notificação se o LED estiver disponível no dispositivo. O tempo total de piscar é controlado pelo SO. |
| localOnly (em inglês) | booleano | Define se a notificação é relevante apenas para o dispositivo atual ou não. Algumas notificações podem ser conectadas a outros dispositivos para exibição remota, como um relógio Wear OS. Essa dica pode ser configurada para recomendar que a notificação não seja transmitida. Consulte os guias do Wear OS. |
| notificationCount (em inglês) | number | Define o número de itens que essa notificação representa. Pode ser exibido como uma contagem de selos para telas de início compatíveis. Consulte NotificationBadge. Por exemplo, isso pode ser útil se você estiver usando apenas uma notificação para representar várias novas mensagens, mas quiser que a contagem represente o número total de novas mensagens. Se for zero ou não especificado, os sistemas compatíveis com selos vão usar o padrão, que é incrementar um número exibido no menu de pressionamento longo sempre que uma nova notificação chegar. |
| prioridade | ('mín' | 'baixa' | 'padrão' | 'alto' | 'máx.') | Define a prioridade relativa da notificação. Notificações de baixa prioridade podem ficar ocultas para o usuário em determinadas situações. Essa prioridade é diferente de AndroidMessagePriority. Essa prioridade é processada pelo cliente após a entrega da mensagem. Já AndroidMessagePriority é um conceito do FCM que controla quando a mensagem é entregue. |
| som | string | Nome do arquivo do som que será reproduzido quando o dispositivo receber a notificação. |
| fixo | booleano | Se for definida como false ou deixada sem definição, a notificação será dispensada automaticamente quando o usuário clicar nela no painel. Quando definida como true, a notificação persiste mesmo quando o usuário clica nela. |
| marcar | string | Tag de notificação. Esse é um identificador usado para substituir as notificações existentes na gaveta de notificações. Se não está especificado, cada solicitação cria uma nova notificação. |
| codigo_da_acao | string | Define o "ticker" que é enviado aos serviços de acessibilidade. Antes do nível 21 da API (Lollipop), define o texto que é exibido na barra de status quando a notificação chega pela primeira vez. |
| title | string | Título da notificação do Android. Quando fornecido, substitui o título definido por admin.messaging.Notification. |
| titleLocArgs (em inglês) | string[] | Uma matriz de chaves de recurso que serão usadas no lugar dos especificadores de formato em titleLocKey. |
| titleLocKey (link em inglês) | string | Chave da string do título no recurso de string do app a ser usada para localizar o texto do título. |
| vibrateTimingsMillis | número[] | Define o padrão de vibração a ser usado. Transmita uma matriz de milissegundos para ativar ou desativar a vibração. O primeiro valor indica a duração de espera antes de ativar a vibração. O próximo valor indica a duração para manter a vibração ligada. Os valores seguintes se alternam entre a duração para desativar e ativar a vibração. Se vibrate_timings for definido e default_vibrate_timings for definido como true, o valor padrão será usado em vez do vibrate_timings especificado pelo usuário. |
| visibilidade | ("privado" | "público" | "secreto") | Define a visibilidade da notificação. Precisa ser private, public ou secret. Se não for especificado, o padrão será private. |
AndroidNotification.body
Corpo da notificação do Android. Quando fornecido, substitui o corpo definido por admin.messaging.Notification.
Assinatura:
body?: string;
AndroidNotification.bodyLocArgs
Uma matriz de chaves de recurso que serão usadas no lugar dos especificadores de formato em bodyLocKey.
Assinatura:
bodyLocArgs?: string[];
AndroidNotification.bodyLocKey
Chave da string do corpo no recurso de string do app a ser usada para localizar o texto do corpo.
Assinatura:
bodyLocKey?: string;
AndroidNotification.channelId
O ID do canal de notificação do Android (novo no Android O). O app precisa criar um canal com este ID do canal para que qualquer notificação com ele seja recebida. Se você não enviar esse ID do canal na solicitação ou se o ID do canal fornecido ainda não tiver sido criado pelo app, o FCM usará o ID do canal especificado no manifesto do app.
Assinatura:
channelId?: string;
AndroidNotification.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.
Assinatura:
clickAction?: string;
AndroidNotification.color
Cor do ícone de notificação no formato #rrggbb.
Assinatura:
color?: string;
AndroidNotification.defaultLightSettings
Se definida como true, use as configurações de luz de LED padrão do framework do Android para a notificação. Os valores padrão são especificados em config.xml. Se default_light_settings for definido como true e light_settings também for definido, o light_settings especificado pelo usuário será usado no lugar do valor padrão.
Assinatura:
defaultLightSettings?: boolean;
AndroidNotification.defaultSound
Se definido como true, usa o som padrão do framework do Android para a notificação. Os valores padrão são especificados em config.xml.
Assinatura:
defaultSound?: boolean;
AndroidNotification.defaultVibrateTimings
Se definido como true, use o padrão de vibração padrão do framework do Android para a notificação. Os valores padrão são especificados em config.xml. Se default_vibrate_timings for definido como true e vibrate_timings também for definido, o valor padrão será usado em vez do vibrate_timings especificado pelo usuário.
Assinatura:
defaultVibrateTimings?: boolean;
AndroidNotification.eventTimestamp
Para notificações que informam os usuários sobre eventos com uma referência de tempo absoluto, define a hora em que o evento na notificação ocorreu. As notificações no painel são classificadas por esse horário.
Assinatura:
eventTimestamp?: Date;
AndroidNotification.icon
Recurso de ícone para a notificação do Android.
Assinatura:
icon?: string;
AndroidNotification.imageUrl
URL de uma imagem a ser exibido na notificação.
Assinatura:
imageUrl?: string;
AndroidNotification.lightSettings
Configurações para controlar a taxa de piscar e a cor do LED da notificação se o LED estiver disponível no dispositivo. O tempo total de piscar é controlado pelo SO.
Assinatura:
lightSettings?: LightSettings;
AndroidNotification.localOnly
Define se a notificação é relevante apenas para o dispositivo atual ou não. Algumas notificações podem ser conectadas a outros dispositivos para exibição remota, como um relógio Wear OS. Essa dica pode ser configurada para recomendar que a notificação não seja transmitida. Consulte os guias do Wear OS.
Assinatura:
localOnly?: boolean;
AndroidNotification.notificationCount
Define o número de itens que essa notificação representa. Pode ser exibido como uma contagem de selos para telas de início compatíveis. Consulte NotificationBadge. Por exemplo, isso pode ser útil se você estiver usando apenas uma notificação para representar várias novas mensagens, mas quiser que a contagem represente o número total de novas mensagens. Se for zero ou não especificado, os sistemas compatíveis com selos vão usar o padrão, que é incrementar um número exibido no menu de pressionamento longo sempre que uma nova notificação chegar.
Assinatura:
notificationCount?: number;
AndroidNotification.priority
Define a prioridade relativa da notificação. Notificações de baixa prioridade podem ficar ocultas para o usuário em determinadas situações. Essa prioridade é diferente de AndroidMessagePriority. Essa prioridade é processada pelo cliente após a entrega da mensagem. Já AndroidMessagePriority é um conceito do FCM que controla quando a mensagem é entregue.
Assinatura:
priority?: ('min' | 'low' | 'default' | 'high' | 'max');
Notificação de som do Android
Nome do arquivo do som que será reproduzido quando o dispositivo receber a notificação.
Assinatura:
sound?: string;
AndroidNotification.sticky
Se for definida como false ou deixada sem definição, a notificação será dispensada automaticamente quando o usuário clicar nela no painel. Quando definida como true, a notificação persiste mesmo quando o usuário clica nela.
Assinatura:
sticky?: boolean;
AndroidNotification.tag
Tag de notificação. Esse é um identificador usado para substituir as notificações existentes na gaveta de notificações. Se não está especificado, cada solicitação cria uma nova notificação.
Assinatura:
tag?: string;
AndroidNotification.ticker
Define o "ticker" que é enviado aos serviços de acessibilidade. Antes do nível 21 da API (Lollipop), define o texto que é exibido na barra de status quando a notificação chega pela primeira vez.
Assinatura:
ticker?: string;
AndroidNotification.title
Título da notificação do Android. Quando fornecido, substitui o título definido por admin.messaging.Notification.
Assinatura:
title?: string;
AndroidNotification.titleLocArgs
Uma matriz de chaves de recurso que serão usadas no lugar dos especificadores de formato em titleLocKey.
Assinatura:
titleLocArgs?: string[];
AndroidNotification.titleLocKey
Chave da string do título no recurso de string do app a ser usada para localizar o texto do título.
Assinatura:
titleLocKey?: string;
AndroidNotification.vibrateTimingsMillis
Define o padrão de vibração a ser usado. Transmita uma matriz de milissegundos para ativar ou desativar a vibração. O primeiro valor indica a duração de espera antes de ativar a vibração. O próximo valor indica a duração para manter a vibração ligada. Os valores seguintes se alternam entre a duração para desativar e ativar a vibração. Se vibrate_timings for definido e default_vibrate_timings for definido como true, o valor padrão será usado no lugar do vibrate_timings especificado pelo usuário.
Assinatura:
vibrateTimingsMillis?: number[];
AndroidNotification.visibility
Define a visibilidade da notificação. Precisa ser private, public ou secret. Se não for especificado, o padrão será private.
Assinatura:
visibility?: ('private' | 'public' | 'secret');