@firebase/messaging/sw

Funções

Função	Descrição
função(aplicativo...)
getMessaging(aplicativo)	Recupera uma instância do Firebase Cloud Messaging.
função(mensagem...)
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 habilitar ou desabilitar a exportação em tempo de execução.
onBackgroundMessage(messaging, 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
FcmOptions	Opções de recursos fornecidos pelo FCM SDK for Web. Consulte WebpushFcmOptions .
GetTokenOptions	Opções para getToken() .
MessagePayload	Carga útil da mensagem que contém a carga útil da notificação representada com NotificationPayload e a carga útil dos dados que contém um número arbitrário de pares chave-valor enviados pelos desenvolvedores por meio da API de envio .
Mensagens	Interface pública do Firebase Cloud Messaging SDK.
Carga útil de notificação	Exibir detalhes da notificação. Os detalhes são enviados por meio da API de envio .

getMessaging()

Recupera uma instância do Firebase Cloud Messaging.

Assinatura:

export declare function getMessagingInSw(app?: FirebaseApp): Messaging;

Parâmetros

Parâmetro	Tipo	Descrição
aplicativo	FirebaseApp

Retorna:

Mensagens

A instância do Firebase Cloud Messaging associada ao aplicativo firebase fornecido.

experimentalSetDeliveryMetricsExportedToBigQueryEnabled()

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 habilitar ou desabilitar 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 `FirebaseMessaging` .
habilitar	boleano	Se o Firebase Cloud Messaging deve exportar métricas de entrega de mensagens para o BigQuery.

Retorna:

vazio

onBackgroundMessage()

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óximoOuObservador	NextFn < MessagePayload > \| Observador < MessagePayload >	Essa função, ou objeto observador com `next` definido, é chamada quando uma mensagem é recebida e o aplicativo está em segundo plano.

Retorna:

Cancelar subscrição

Para parar de ouvir mensagens, execute esta função retornada

é suportado()

Verifica se todas as APIs necessárias existem no SW Context

Assinatura:

export declare function isSwSupported(): Promise<boolean>;

Retorna:

Promessa<booleana>

uma promessa que resolve para um booleano.