@firebase/messaging

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, ...)
deleteToken(messaging) Exclui o token de registro associado a essa instância de Messaging e cancela a inscrição da instância de Messaging da assinatura de push.
getToken(messaging, options) Inscreve a instância de Messaging para receber notificações push. Retorna um token de registro do Firebase Cloud Messaging que pode ser usado para enviar mensagens push para essa instância de Messaging.Se a permissão de notificações ainda não tiver sido concedida, esse método solicitará a permissão do usuário. A promessa retornada será rejeitada se o usuário não permitir que o app mostre notificações.
onMessage(messaging, nextOrObserver) Quando uma mensagem push é recebida e o usuário está em uma página da sua origem no momento, a mensagem é transmitida para a página, e um evento onMessage() é despachado com o payload da mensagem push.
function().
issupported(); Verifica se todas as APIs necessárias existem no navegador.

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 getMessagingInWindow(app?: FirebaseApp): Messaging;

Parâmetros

Parâmetro Tipo Descrição
app FirebaseApp

Retorna:

Mensagens

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

função(mensagens, ...)

deleteToken(mensagens)

Exclui o token de registro associado a essa instância de Messaging e cancela a inscrição da instância de Messaging da assinatura de push.

Assinatura:

export declare function deleteToken(messaging: Messaging): Promise<boolean>;

Parâmetros

Parâmetro Tipo Descrição
Mensagens Mensagens A instância de Messaging.

Retorna:

Promise&lt;boolean&gt;

A promessa é resolvida quando o token é excluído com sucesso.

getToken(mensagens, opções)

Inscreve a instância de Messaging para receber notificações push. Retorna um token de registro do Firebase Cloud Messaging que pode ser usado para enviar mensagens push para essa instância do Messaging.

Se a permissão de notificações ainda não tiver sido concedida, esse método solicitará a permissão do usuário. A promessa retornada será rejeitada se o usuário não permitir que o app mostre notificações.

Assinatura:

export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;

Parâmetros

Parâmetro Tipo Descrição
Mensagens Mensagens A instância de Messaging.
options GetTokenOptions (em inglês) Fornece uma chave vapid opcional e um registro opcional de service worker.

Retorna:

Promessa<string>

A promessa é resolvida com um token de registro do FCM.

onMessage(mensagens; nextOrObserver)

Quando uma mensagem push é recebida e o usuário está em uma página da sua origem no momento, a mensagem é transmitida para a página, e um evento onMessage() é despachado com o payload da mensagem push.

Assinatura:

export declare function onMessage(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 usuário está visualizando a página no momento.

Retorna:

Cancelar inscrição

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

função()

issupported();

Verifica se todas as APIs necessárias existem no navegador.

Assinatura:

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

Retorna:

Promise&lt;boolean&gt;

uma promessa que é resolvida em um booleano.