firebase-admin.messaging package

o Firebase Cloud Messaging (FCM).

Funções

Função	Descrição
getMessaging(app).	Recebe o serviço Messaging do app padrão ou de um determinado app.admin.messaging() pode ser chamado sem argumentos para acessar o serviço Messaging do app padrão ou como admin.messaging(app) para acessar o serviço Messaging associado a um app específico.

Aulas

Turma	Descrição
Mensagens	Serviço de mensagens vinculado ao app fornecido.

Interfaces

Interface	Descrição
AndroidConfig (em inglês)	Representa as opções específicas do Android que podem ser incluídas em uma Message.
AndroidFcmOptions (em inglês)	Representa opções de recursos fornecidos pelo SDK do FCM para Android.
AndroidNotification (link em inglês)	Representa as opções de notificação específicas do Android que podem ser incluídas em AndroidConfig.
ApnsConfig (em inglês)	Representa as opções específicas de APNs que podem ser incluídas em uma Message. Consulte a documentação da Apple para vários cabeçalhos e campos de payload aceitos por APNs.
ApnsFcmOptions (em inglês)	Representa opções de recursos fornecidos pelo SDK do FCM para iOS.
ApnsPayload (em inglês)	Representa o payload de uma mensagem de APNs. Consiste principalmente no dicionário aps. Mas também pode conter outras chaves personalizadas arbitrárias.
Aps	Representa o dicionário aps que faz parte das mensagens de APNs.
ApsAlert (link em inglês)
BaseMessage
BatchResponse	Interface que representa a resposta do servidor dos métodos Messaging.sendAll() e Messaging.sendMulticast().
ConditionMessage
CriticalSound	Representa uma configuração de som crítica que pode ser incluída no dicionário aps de um payload de APNs.
DataMessagePayload (em inglês)	Interface que representa um payload de mensagens de dados da API legada do FCM. As mensagens de dados permitem que os desenvolvedores enviem até 4 KB de pares de chave-valor personalizados. As chaves e os valores precisam ser strings. As chaves podem ser qualquer string personalizada, exceto as seguintes strings reservadas: from Qualquer coisa que comece com google. Consulte Criar solicitações de envio para exemplos de código e documentação detalhada.
FcmOptions (em inglês)	Representa opções independentes de plataforma para recursos fornecidos pelos SDKs do FCM.
LightSettings (link em inglês)	Representa as configurações para controlar o LED de notificações que podem ser incluídos em AndroidNotification.
MessagingConditionResponse (link em inglês)	Interface que representa a resposta do servidor do método legado Messaging.sendToCondition().Consulte Enviar para uma condição para exemplos de código e documentação detalhada.
MessagingDeviceGroupResponse (em inglês)	Interface que representa a resposta do servidor do método Messaging.sendToDeviceGroup().Consulte Enviar mensagens a grupos de dispositivos para exemplos de código e documentação detalhada.
MessagingDeviceResult.	Payload de resposta de status individual de dispositivos únicos
MessagingDevicesResponse	Interface que representa o status de uma mensagem enviada a um dispositivo individual pelas APIs legadas do FCM.Consulte Enviar a dispositivos individuais para exemplos de código e documentação detalhada.
MessagingOptions	Interface que representa as opções que podem ser fornecidas ao enviar uma mensagem por meio das APIs legadas do FCM.Consulte Criar solicitações de envio para conferir exemplos de código e a documentação detalhada.
MessagingPayload (em inglês)	Interface que representa um payload de mensagens do Firebase Cloud Messaging. Uma ou ambas as chaves data e notification são obrigatórias.Consulte Solicitações de envio de criação para exemplos de código e documentação detalhada.
MessagingTopicManagementResponse	Interface que representa a resposta do servidor dos métodos Messaging.subscribeToTopic() e Messaging.unsubscribeFromTopic().Consulte Gerenciar tópicos do servidor para exemplos de código e documentação detalhada.
MessagingTopicResponse (link em inglês)	Interface que representa a resposta do servidor do método Messaging.sendToTopic() legado.Consulte Enviar para um tópico para exemplos de código e documentação detalhada.
MulticastMessage (link em inglês)	Payload para o método Messaging.sendMulticast(). O payload contém todos os campos do tipo BaseMessage e uma lista de tokens.
Notificação	Uma notificação que pode ser incluída em Message.
NotificationMessagePayload	Interface que representa um payload da mensagem de notificação da API legada do FCM. As mensagens de notificação permitem que os desenvolvedores enviem até 4 KB de pares de chave-valor predefinidos. As chaves aceitas estão descritas abaixo.Consulte Criar solicitações de envio para conferir exemplos de código e a documentação detalhada.
SendResponse (link em inglês)	Interface que representa o status de uma mensagem individual enviada como parte de uma solicitação em lote.
TokenMessage (link em inglês)
TopicMessage
WebpushConfig (link em inglês)	Representa as opções de protocolo WebPush que podem ser incluídas em uma Message.
WebpushFcmOptions (em inglês)	Representa opções de recursos fornecidos pelo SDK do FCM para a Web, que não fazem parte do padrão Webpush.
WebpushNotification (link em inglês)	Representa as opções de notificação específicas do WebPush que podem ser incluídas em WebpushConfig. Ele é compatível com a maioria das opções padrão, conforme definido na especificação das notificações da Web.

Aliases de tipos

Tipo de alias	Descrição
Mensagem	Payload para a operação Messaging.send(). A carga útil contém todos os campos no tipo BaseMessage e exatamente um de token, tópico ou condição.

getMessaging(app)

Recebe o serviço Messaging para o app padrão ou um determinado app.

admin.messaging() pode ser chamado sem argumentos para acessar o serviço Messaging do app padrão ou como admin.messaging(app) para acessar o serviço Messaging associado a um app específico.

Assinatura:

export declare function getMessaging(app?: App): Messaging;

Parâmetros

Parâmetro	Tipo	Descrição
app	App	App opcional cujo serviço Messaging será retornado. Caso não seja fornecido, o serviço Messaging padrão será retornado.

Retorna:

Mensagens

O serviço Messaging padrão, se nenhum app for fornecido, ou o serviço Messaging associado ao app fornecido.

Exemplo 1

// Get the Messaging service for the default app
const defaultMessaging = getMessaging();

Exemplo 2

// Get the Messaging service for a given app
const otherMessaging = getMessaging(otherApp);

Mensagem

Payload para a operação Messaging.send(). A carga útil contém todos os campos no tipo BaseMessage e exatamente um de token, tópico ou condição.

Assinatura:

export type Message = TokenMessage | TopicMessage | ConditionMessage;