Funções
| Função | Descrição |
|---|---|
| function(app, ...) (link em inglês) | |
| getMessaging(app) (em inglês) | 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 esse método para ativar ou desativar a exportação no tempo de execução. |
| onBackgroundMessage(messages, nextOrObserver) | Chamado quando uma mensagem é recebida enquanto o app está em segundo plano. Um app é considerado em segundo plano quando nenhuma janela ativa é mostrada. |
| function(). | |
| issupported(); | Verifica se todas as APIs necessárias existem no contexto do SW |
Interfaces
| Interface | Descrição |
|---|---|
| FcmOptions (em inglês) | Opções para recursos fornecidos pelo SDK do FCM para a Web. Consulte WebpushFcmOptions. |
| GetTokenOptions (em inglês) | Opções para getToken(). |
| MessagePayload (link em inglês) | Payload da mensagem que contém o payload da notificação representado por NotificationPayload e o payload de dados que contém um número arbitrário de pares de chave-valor enviados por desenvolvedores pela API Send. |
| Mensagens | Interface pública do SDK do Firebase Cloud Messaging. |
| NotificationPayload (em inglês) | Mostrar detalhes da notificação. Os detalhes são enviados pela API Send. |
função(app, ...)
getMessaging(app)
Recupera uma instância do Firebase Cloud Messaging.
Assinatura:
export declare function getMessagingInSw(app?: FirebaseApp): Messaging;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| app | FirebaseApp |
Retorna:
A instância do Firebase Cloud Messaging associada ao app do 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 esse método para ativar ou desativar a exportação no 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 FirebaseMessaging. |
| ativar | booleano | Se o Firebase Cloud Messaging deve exportar métricas de entrega de mensagens para o BigQuery. |
Retorna:
void
onBackgroundMessage(messages, nextOrObserver)
Chamado quando uma mensagem é recebida enquanto o app está em segundo plano. Um app é considerado em segundo plano quando nenhuma janela ativa é mostrada.
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 Messaging. |
| nextOrObserver | NextFn<MessagePayload> | Observador<MessagePayload> | Essa função, ou objeto observador com next definido, é chamada quando uma mensagem é recebida e o app está em segundo plano no momento. |
Retorna:
Para parar de detectar mensagens, execute esta função retornada
função()
issupported();
Verifica se todas as APIs necessárias existem no contexto do SW
Assinatura:
export declare function isSwSupported(): Promise<boolean>;
Retorna:
Promise<boolean>
uma promessa que é resolvida em um booleano.