@firebase/messaging

Funções

Função Descrição
função(aplicativo...)
getMessaging(aplicativo) Recupera uma instância do Firebase Cloud Messaging.
função(mensagem...)
deleteToken(mensagem) Exclui o token de registro associado a esta instância do Messaging e cancela a assinatura da instância do Messaging da assinatura push.
getToken(mensagens, opções) Inscreve a instância do Messaging para notificações por 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ção ainda não tiver sido concedida, esse método solicitará permissão ao usuário. A promessa retornada é rejeitada se o usuário não permitir que o aplicativo mostre notificações.
onMessage(messaging, nextOrObserver) Quando uma mensagem push é recebida e o usuário está atualmente em uma página para sua origem, a mensagem é passada para a página e um evento onMessage() é despachado com a carga útil da mensagem push.
função()
é suportado() Verifica se todas as APIs necessárias existem no navegador.

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 getMessagingInWindow(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.

deletarToken()

Exclui o token de registro associado a esta instância do Messaging e cancela a assinatura da instância do Messaging da assinatura push.

Assinatura:

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

Parâmetros

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

Retorna:

Promessa<booleana>

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

getToken()

Inscreve a instância do Messaging para notificações por 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ção ainda não tiver sido concedida, esse método solicitará permissão ao usuário. A promessa retornada é rejeitada se o usuário não permitir que o aplicativo 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 mensagens .
opções GetTokenOptions Fornece uma chave insípida opcional e um registro de service worker opcional.

Retorna:

Promessa<string>

A promessa é resolvida com um token de registro FCM.

onMessage()

Quando uma mensagem push é recebida e o usuário está atualmente em uma página para sua origem, a mensagem é passada para a página e um evento onMessage() é despachado com a carga útil 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 mensagens .
próximoOuObservador NextFn < MessagePayload > | Observador < MessagePayload > Esta função, ou objeto observador com next definido, é chamada quando uma mensagem é recebida e o usuário está visualizando sua página.

Retorna:

Cancelar subscrição

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

é suportado()

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

Assinatura:

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

Retorna:

Promessa<booleana>

uma promessa que resolve para um booleano.