Funções
| Função | Descrição |
|---|---|
| função (aplicativo, ...) | |
| getMessaging(aplicativo) | Recupera uma instância do Firebase Cloud Messaging. |
| função (mensagens, ...) | |
| experimentalSetDeliveryMetricsExportedToBigQueryEnabled(mensagens, ativar) | Ativa ou desativa a exportação de métricas de entrega de mensagens do Firebase Cloud Messaging para o BigQuery. Por padrão, as métricas de entrega de mensagens não são exportadas para o BigQuery. Use este método para ativar ou desativar a exportação em tempo de execução. |
| onBackgroundMessage(mensagens, nextOrObserver) | Chamado quando uma mensagem é recebida enquanto o aplicativo está em segundo plano. Um aplicativo é considerado em segundo plano se nenhuma janela ativa for exibida. |
| função() | |
| é suportado() | Verifica se todas as APIs necessárias existem no SW Context |
Interfaces
| Interface | Descrição |
|---|---|
| Opções Fcm | Opções de recursos fornecidos pelo FCM SDK for Web. Veja WebpushFcmOptions . |
| GetTokenOptions | Opções para getToken() . |
| MensagemPayload | Carga de mensagem que contém a carga de notificação representada com NotificationPayload e a carga de dados que contém um número arbitrário de pares de valores-chave enviados pelos desenvolvedores por meio da API Send . |
| Mensagens | Interface pública do SDK do Firebase Cloud Messaging. |
| NotificaçãoPayload | Exibir detalhes da notificação. Os detalhes são enviados por meio da API Send . |
função (aplicativo, ...)
getMessaging(aplicativo)
Recupera uma instância do Firebase Cloud Messaging.
Assinatura:
export declare function getMessagingInSw(app?: FirebaseApp): Messaging;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| aplicativo | Aplicativo Firebase |
Retorna:
A instância do Firebase Cloud Messaging associada ao aplicativo Firebase fornecido.
função (mensagens, ...)
experimentalSetDeliveryMetricsExportedToBigQueryEnabled(mensagens, ativar)
Ativa ou desativa a exportação de métricas de entrega de mensagens do Firebase Cloud Messaging para o BigQuery. Por padrão, as métricas de entrega de mensagens não são exportadas para o BigQuery. Use este método para ativar ou desativar a exportação em tempo de execução.
Assinatura:
export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| Mensagens | Mensagens | A instância do FirebaseMessaging . |
| habilitar | boleano | Se o Firebase Cloud Messaging deve exportar métricas de entrega de mensagens para o BigQuery. |
Retorna:
vazio
onBackgroundMessage(mensagens, nextOrObserver)
Chamado quando uma mensagem é recebida enquanto o aplicativo está em segundo plano. Um aplicativo é considerado em segundo plano se nenhuma janela ativa for exibida.
Assinatura:
export declare function onBackgroundMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| Mensagens | Mensagens | A instância de mensagens . |
| próximoOrObserver | PróximoFn < MensagemPayload > | Observador < MensagemPayload > | Esta função, ou objeto observador com next definido, é chamada quando uma mensagem é recebida e o aplicativo está em segundo plano. |
Retorna:
Para parar de ouvir mensagens, execute esta função retornada
função()
é suportado()
Verifica se todas as APIs necessárias existem no SW Context
Assinatura:
export declare function isSwSupported(): Promise<boolean>;
Retorna:
Promessa<booleano>
uma promessa que resolve para um booleano.