Mensagens em nuvem do Firebase (FCM).
Funções
| Função | Descrição |
|---|---|
| getMessaging(aplicativo) | Obtém o serviço de mensagens do aplicativo padrão ou de um determinado aplicativo. admin.messaging() pode ser chamado sem argumentos para acessar o serviço Messaging do aplicativo padrão ou como admin.messaging(app) para acessar o serviço Messaging associado a um aplicativo específico. |
Aulas
| Aula | Descrição |
|---|---|
| Mensagens | Serviço de mensagens vinculado ao aplicativo fornecido. |
Interfaces
| Interface | Descrição |
|---|---|
| AndroidConfig | Representa as opções específicas do Android que podem ser incluídas em uma mensagem . |
| Opções AndroidFcm | Representa opções de recursos fornecidos pelo SDK do FCM para Android. |
| Notificação Android | Representa as opções de notificação específicas do Android que podem ser incluídas no AndroidConfig . |
| ApnsConfig | Representa as opções específicas de APNs que podem ser incluídas em uma mensagem . Consulte a documentação da Apple para vários cabeçalhos e campos de carga suportados por APNs. |
| Opções ApnsFcm | Representa opções de recursos fornecidos pelo SDK do FCM para iOS. |
| ApnsPayload | Representa a carga útil 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. |
| Alerta Aps | |
| Mensagem Base | |
| Resposta em lote | Interface que representa a resposta do servidor dos métodos Messaging.sendAll() e Messaging.sendMulticast() . |
| Mensagem de Condição | |
| Som Crítico | Representa uma configuração de som crítica que pode ser incluída no dicionário aps de uma carga útil de APNs. |
| DataMessagePayload | Interface que representa uma carga útil de mensagem de dados da API legada do FCM. As mensagens de dados permitem que os desenvolvedores enviem até 4 KB de pares de valores-chave personalizados. As chaves e os valores devem ser strings. As chaves podem ser qualquer string personalizada, exceto as seguintes strings reservadas:
|
| Opções Fcm | Representa opções independentes de plataforma para recursos fornecidos pelos SDKs do FCM. |
| Configurações de luz | Representa configurações para controlar o LED de notificação que pode ser incluído no AndroidNotification . |
| MensagensCondiçãoResposta | Interface que representa a resposta do servidor do método legado Messaging.sendToCondition() . Consulte Enviar para uma condição para obter exemplos de código e documentação detalhada. |
| MensagensDeviceGroupResponse | Interface que representa a resposta do servidor do método Messaging.sendToDeviceGroup() . Consulte Enviar mensagens para grupos de dispositivos para obter exemplos de código e documentação detalhada. |
| MensagensDeviceResult | Carga útil de resposta de status individual de dispositivos únicos |
| MensagensDispositivosResposta | Interface que representa o status de uma mensagem enviada a um dispositivo individual por meio das APIs legadas do FCM. Consulte Enviar para dispositivos individuais para obter exemplos de código e documentação detalhada. |
| Opções de mensagens | Interface que representa as opções que podem ser fornecidas ao enviar uma mensagem por meio das APIs legadas do FCM. Consulte Build enviar solicitações para amostras de código e documentação detalhada. |
| MensagensPayload | Interface que representa uma carga de mensagem do Firebase Cloud Messaging. Uma ou ambas as chaves de data e notification são necessárias. Consulte Build enviar solicitações para amostras de código e documentação detalhada. |
| MensagensTópicoGerenciamentoResposta | Interface que representa a resposta do servidor dos métodos Messaging.subscribeToTopic() e Messaging.unsubscribeFromTopic() . Consulte Gerenciar tópicos do servidor para obter exemplos de código e documentação detalhada. |
| MensagensTopicResponse | Interface que representa a resposta do servidor do método legado Messaging.sendToTopic() . Consulte Enviar para um tópico para obter exemplos de código e documentação detalhada. |
| Mensagem multicast | Carga útil para o método Messaging.sendMulticast() . A carga contém todos os campos do tipo BaseMessage e uma lista de tokens. |
| Notificação | Uma notificação que pode ser incluída na Mensagem . |
| NotificaçãoMessagePayload | Interface que representa uma carga útil de 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 valores-chave predefinidos. As chaves aceitas estão descritas abaixo. Consulte Build enviar solicitações para amostras de código e documentação detalhada. |
| EnviarResposta | Interface que representa o status de uma mensagem individual enviada como parte de uma solicitação em lote. |
| Mensagem de token | |
| Mensagem do tópico | |
| WebpushConfig | Representa as opções do protocolo WebPush que podem ser incluídas em uma mensagem . |
| Opções WebpushFcm | Representa opções de recursos fornecidos pelo FCM SDK for Web (que não fazem parte do padrão Webpush). |
| Notificação Webpush | Representa as opções de notificação específicas do WebPush que podem ser incluídas no WebpushConfig . Isso suporta a maioria das opções padrão definidas na especificação de notificação da Web . |
Aliases de tipo
| Digite Alias | Descrição |
|---|---|
| Mensagem | Carga útil para a operação Messaging.send() . A carga útil contém todos os campos do tipo BaseMessage e exatamente um de token, tópico ou condição. |
getMessaging()
Obtém o serviço de mensagens do aplicativo padrão ou de um determinado aplicativo.
admin.messaging() pode ser chamado sem argumentos para acessar o serviço Messaging do aplicativo padrão ou como admin.messaging(app) para acessar o serviço Messaging associado a um aplicativo específico.
Assinatura:
export declare function getMessaging(app?: App): Messaging;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| aplicativo | Aplicativo | Aplicativo opcional cujo serviço Messaging será retornado. Se não for fornecido, o serviço Messaging padrão será retornado. |
Retorna:
O serviço Messaging padrão se nenhum aplicativo for fornecido ou o serviço Messaging associado ao aplicativo 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
Carga útil para a operação Messaging.send() . A carga útil contém todos os campos do tipo BaseMessage e exatamente um de token, tópico ou condição.
Assinatura:
export type Message = TokenMessage | TopicMessage | ConditionMessage;