Firebase Cloud Messaging (FCM).
Funções
| Função | Descrição |
|---|---|
| getMessaging(app) (em inglês) | 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. |
Classes
| Turma | Descrição |
|---|---|
| FirebaseMessagingError. | Estrutura do código de erro do Firebase Messaging. Isso estende PrefixedFirebaseError. |
| Mensagens | Serviço de mensagens vinculado ao app fornecido. |
| MessagingClientErrorCode. | Códigos de erro do cliente de mensagens e as mensagens padrão delas. |
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 para 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 ver os diversos cabeçalhos e campos de payload suportados pelos APNs. |
| ApnsFcmOptions (em inglês) | Representa opções para 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. |
| Apps | Representa o dicionário de aps que faz parte das mensagens de APNs. |
| ApsAlert (link em inglês) | |
| BaseMessage | |
| BatchResponse (em inglês) | Interface que representa a resposta do servidor dos métodos Messaging.sendAll() e Messaging.sendMulticast(). |
| ConditionMessage (em inglês) | |
| CriticalSound (link em inglês) | Representa uma configuração de som crítica que pode ser incluída no dicionário aps de um payload de APNs. |
| DataMessagePayload (link em inglês) | Interface que representa um payload da mensagem 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. Tanto as chaves quanto os valores precisam ser strings. As chaves podem ser qualquer string personalizada, exceto as seguintes strings reservadas:
|
| FcmOptions (em inglês) | Representa opções independentes de plataforma para recursos fornecidos pelos SDKs do FCM. |
| LightSettings (em inglês) | Representa configurações para controlar o LED de notificações que pode ser incluído em AndroidNotification. |
| MessagingConditionResponse | Interface que representa a resposta do servidor do método Messaging.sendToCondition() legado.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 para grupos de dispositivos para exemplos de código e documentação detalhada. |
| MessagingDeviceResult. | Payload de resposta de status individual de dispositivos únicos |
| MessagingDevicesResponse (em inglês). | Interface que representa o status de uma mensagem enviada a um dispositivo individual pelas APIs legadas do FCM.Consulte Enviar para dispositivos individuais para exemplos de código e documentação detalhada. |
| MessagingOptions (em inglês) | 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 exemplos de código e documentação detalhada. |
| MessagingPayload (em inglês) | Interface que representa um payload de mensagem do Firebase Cloud Messaging. Uma ou ambas as chaves data e notification são obrigatórias.Consulte Criar solicitações de envio 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 ver exemplos de código e documentação detalhada. |
| MessagingTopicResponse (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 (em inglês) | Payload do 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 (em inglês) | 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 ver exemplos de código e documentação detalhada. |
| SendResponse (em inglês) | Interface que representa o status de uma mensagem individual enviada como parte de uma solicitação em lote. |
| TokenMessage (em inglês) | |
| TopicMessage (link em inglês) | |
| WebpushConfig (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 para recursos fornecidos pelo SDK do FCM para a Web (que não fazem parte do padrão Webpush). |
| WebpushNotification (em inglês) | Representa as opções de notificação específicas do WebPush que podem ser incluídas em WebpushConfig. Esse recurso é compatível com a maioria das opções padrão, conforme definido na especificação da notificação da Web. |
Aliases de tipos
| Alias de tipo | Descrição |
|---|---|
| Mensagem | Payload da operação Messaging.send(). A carga útil contém todos os campos do tipo BaseMessage e exatamente um token, tópico ou condição. |
getMessaging(app)
Recebe o serviço Messaging do app padrão ou de um determinado app.
O 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 deve ser retornado. Se não for informado, o serviço Messaging padrão será retornado. |
Retorna:
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 da operação Messaging.send(). A carga útil contém todos os campos do tipo BaseMessage e exatamente um token, tópico ou condição.
Assinatura:
export type Message = TokenMessage | TopicMessage | ConditionMessage;