AndroidNotification interface

Representa as opções de notificação específicas do Android que podem ser incluídas no AndroidConfig .

Assinatura:

export interface AndroidNotification 

Propriedades

AndroidNotification.body

Corpo da notificação do Android. Quando fornecido, substitui o corpo definido por meio de admin.messaging.Notification .

Assinatura:

body?: string;

AndroidNotification.bodyLocArgs

Uma matriz de chaves de recursos 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 aplicativo 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 aplicativo deve criar um canal com esse ID de canal antes que qualquer notificação com esse ID de canal possa ser recebida. Se você não enviar esse ID de canal na solicitação ou se o ID de canal fornecido ainda não tiver sido criado pelo aplicativo, o FCM usará o ID de canal especificado no manifesto do aplicativo.

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 Intenção correspondente será iniciada quando um usuário clicar na notificação.

Assinatura:

clickAction?: string;

AndroidNotification.color

Cor do ícone de notificação no formato #rrggbb .

Assinatura:

color?: string;

AndroidNotification.defaultLightSettings

Se definido como true , use as configurações de luz LED padrão da estrutura do Android para a notificação. Os valores padrão são especificados em config.xml . Se default_light_settings estiver definido como true e light_settings também estiver definido, o light_settings especificado pelo usuário será usado em vez do valor padrão.

Assinatura:

defaultLightSettings?: boolean;

AndroidNotification.defaultSound

Se definido como true , use o som padrão da estrutura 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 da estrutura do Android para a notificação. Os valores padrão são especificados em config.xml . Se default_vibrate_timings estiver definido como true e vibrate_timings também estiver 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 aos usuários sobre eventos com referência de tempo absoluto, define a hora em que ocorreu o evento na notificação. As notificações no painel são classificadas por esse horário.

Assinatura:

eventTimestamp?: Date;

AndroidNotification.icon

Recurso de ícone para notificação do Android.

Assinatura:

icon?: string;

AndroidNotification.imageUrl

URL de uma imagem a ser exibida na notificação.

Assinatura:

imageUrl?: string;

AndroidNotification.lightSettings

Configurações para controlar a taxa de intermitência e a cor do LED da notificação se o LED estiver disponível no dispositivo. O tempo total de piscar é controlado pelo sistema operacional.

Assinatura:

lightSettings?: LightSettings;

AndroidNotification.localOnly

Define se esta notificação é ou não relevante apenas para o dispositivo atual. Algumas notificações podem ser transferidas para outros dispositivos para exibição remota, como um relógio Wear OS. Esta dica pode ser definida para recomendar que esta notificação não seja interligada. Consulte os guias do Wear OS .

Assinatura:

localOnly?: boolean;

AndroidNotification.notificationCount

Define o número de itens que esta notificação representa. Pode ser exibido como uma contagem de emblemas para lançadores que suportam emblemas. Veja NotificationBadge . Por exemplo, isso pode ser útil se você estiver usando apenas uma notificação para representar várias mensagens novas, mas quiser que a contagem aqui represente o número total de novas mensagens. Se for zero ou não especificado, os sistemas que suportam crachás usam o padrão, que é incrementar um número exibido no menu pressionado cada vez que uma nova notificação chega.

Assinatura:

notificationCount?: number;

AndroidNotification.priority

Define a prioridade relativa para esta notificação. Notificações de baixa prioridade podem ficar ocultas do usuário em determinadas situações. Observe que esta prioridade difere de AndroidMessagePriority . Esta prioridade é processada pelo cliente após a entrega da mensagem. Considerando que AndroidMessagePriority é um conceito FCM que controla quando a mensagem é entregue.

Assinatura:

priority?: ('min' | 'low' | 'default' | 'high' | 'max');

AndroidNotification.sound

Nome do arquivo do som a ser reproduzido quando o dispositivo receber a notificação.

Assinatura:

sound?: string;

AndroidNotification.sticky

Quando definida como false ou não definida, a notificação é automaticamente dispensada quando o usuário clica nela no painel. Quando definido como true , a notificação persistirá mesmo quando o usuário clicar nela.

Assinatura:

sticky?: boolean;

AndroidNotification.tag

Etiqueta de notificação. Este é um 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.

Assinatura:

tag?: string;

AndroidNotification.ticker

Define o texto do “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 meio de admin.messaging.Notification .

Assinatura:

title?: string;

AndroidNotification.titleLocArgs

Uma matriz de chaves de recursos que serão usadas no lugar dos especificadores de formato em titleLocKey .

Assinatura:

titleLocArgs?: string[];

AndroidNotification.titleLocKey

Chave da string de título no recurso de string do aplicativo 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. Passe alguns milissegundos para ligar ou desligar o vibrador. O primeiro valor indica o tempo de espera antes de ligar o vibrador. O próximo valor indica a duração para manter o vibrador ligado. Os valores subsequentes alternam entre a duração para desligar o vibrador e para ligar o vibrador. Se vibrate_timings estiver definido e default_vibrate_timings estiver definido como true , o valor padrão é usado em vez do vibrate_timings especificado pelo usuário .

Assinatura:

vibrateTimingsMillis?: number[];

AndroidNotification.visibility

Define a visibilidade da notificação. Deve ser private , public ou secret . Se não for especificado, o padrão é private .

Assinatura:

visibility?: ('private' | 'public' | 'secret');