Serviço de mensagens vinculado ao app fornecido.
Assinatura:
export declare class Messaging
Propriedades
| Propriedade | Modificadores | Tipo | Descrição |
|---|---|---|---|
| app | App | O app associado à instância de serviço Messaging atual. |
Métodos
| Método | Modificadores | Descrição |
|---|---|---|
| enableLegacyHttpTransport() (em inglês) | Ativa o uso de transporte HTTP/1.1 legado para sendEach() e sendEachForMulticast(). |
|
| send(message, dryRun) | Envia a mensagem especificada pelo FCM. | |
| sendAll(messages, dryRun) (em inglês) | Envia todas as mensagens na matriz especificada pelo Firebase Cloud Messaging. Usa lotes para enviar a lista inteira como uma única chamada RPC. Em comparação com o método send(), esse método é significativamente mais eficiente de enviar várias mensagens.A lista de respostas recebida do valor de retorno corresponde à ordem dos tokens no MulticastMessage. Um erro desse método indica uma falha total, ou seja, nenhuma das mensagens da lista foi enviada. Falhas parciais são indicadas por um valor de retorno BatchResponse. |
|
| sendCada(mensagens, dryRun) | Envia cada mensagem na matriz especificada pelo Firebase Cloud Messaging.Diferentemente do Messaging.sendAll(), esse método faz uma única chamada RPC para cada mensagem na matriz em questão.A lista de respostas recebida do valor de retorno corresponde à ordem de messages. Um erro desse método ou uma BatchResponse com todas as falhas indica uma falha total, ou seja, nenhuma das mensagens da lista foi enviada. Falhas parciais ou nenhuma falha são indicadas apenas por um valor de retorno BatchResponse. |
|
| sendCadaForMulticast(mensagem, dryRun) | Envia a mensagem multicast especificada para todos os tokens de registro do FCM especificados nela.Este método usa internamente a API Messaging.sendevery() para enviar a mensagem a todos os destinatários de destino. A lista de respostas recebida do valor de retorno corresponde à ordem dos tokens no MulticastMessage. Um erro desse método ou de uma BatchResponse com todas as falhas indica uma falha total, o que significa que as mensagens da lista podem ser enviadas. Falhas parciais ou falhas são indicadas apenas por um valor de retorno BatchResponse. |
|
| sendMulticast(mensagem, dryRun) | Envia a mensagem multicast especificada para todos os tokens de registro do FCM especificados nela.Esse método usa a API sendAll() internamente para enviar a mensagem a todos os destinatários de destino. A lista de respostas recebida do valor de retorno corresponde à ordem dos tokens no MulticastMessage. Um erro desse método indica uma falha total, ou seja, a mensagem não foi enviada a nenhum dos tokens da lista. Falhas parciais são indicadas por um valor de retorno BatchResponse. |
|
| sendToCondition(condition, payload, options) | Envia uma mensagem do FCM para uma condição.Consulte Enviar para uma condição para ver exemplos de código e documentação detalhada. | |
| sendToDevice(registerTokenOrTokens, payload, options). | Envia uma mensagem do FCM para um único dispositivo correspondente ao token de registro fornecido.Consulte Enviar para dispositivos individuais para ver exemplos de códigos e documentação detalhada. Usa um registrationToken para enviar a um único dispositivo ou um parâmetro registrationTokens que contém uma matriz de tokens para enviar a vários dispositivos. |
|
| sendToDeviceGroup(notificationKey, payload, options) | Envia uma mensagem do FCM para um grupo de dispositivos correspondente à chave de notificação fornecida.Consulte Enviar a um grupo de dispositivos para ver exemplos de códigos e documentação detalhada. | |
| sendToTopic(topic, payload, options) | Envia uma mensagem do FCM para um tópico.Consulte Enviar para um tópico para ver exemplos de código e documentação detalhada. | |
| subscribeToTopic(registerTokenOrTokens, topic) | Inscreve um dispositivo em um tópico do FCM.Consulte Assinar um tópico para ver exemplos de código e documentação detalhada. Opcionalmente, você pode fornecer uma matriz de tokens para assinar vários dispositivos. | |
| unsubscribeFromTopic(registerTokenOrTokens, topic) | Faz a inscrição de um dispositivo em um tópico do FCM.Consulte Cancelar inscrição em um tópico para ver exemplos de código e documentação detalhada. Opcionalmente, você pode fornecer uma matriz de tokens para cancelar a inscrição de vários dispositivos. |
Messaging.app
O app associado à instância de serviço Messaging atual.
Assinatura:
get app(): App;
Exemplo
var app = messaging.app;
Messaging.enableLegacyHttpTransport()
Ele será removido quando a implementação de transporte HTTP/2 atingir a mesma estabilidade que a implementação HTTP/1.1 legada.
Permite o uso de transporte HTTP/1.1 legado para sendEach() e sendEachForMulticast().
Assinatura:
enableLegacyHttpTransport(): void;
Retorna:
void
Exemplo
const messaging = getMessaging(app);
messaging.enableLegacyTransport();
messaging.sendEach(messages);
Messaging.send().
Envia a mensagem especificada pelo FCM.
Assinatura:
send(message: Message, dryRun?: boolean): Promise<string>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| mensagem | Mensagem | O payload da mensagem. |
| dryRun | booleano | Indica se a mensagem será enviada no modo de simulação (somente validação). |
Retorna:
Promessa<string>
Uma promessa cumprida com uma string de ID de mensagem exclusiva após a mensagem ter sido entregue com sucesso ao serviço do FCM para entrega.
Messaging.sendAll()
Em vez disso, use Messaging.sendeach().
Envia todas as mensagens na matriz especificada pelo Firebase Cloud Messaging. Usa lotes para enviar a lista inteira como uma única chamada RPC. Em comparação com o método send(), esse método é significativamente mais eficiente de enviar várias mensagens.
A lista de respostas recebida do valor de retorno corresponde à ordem dos tokens em MulticastMessage. Um erro desse método indica uma falha total, ou seja, nenhuma das mensagens da lista foi enviada. Falhas parciais são indicadas por um valor de retorno BatchResponse.
Assinatura:
sendAll(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| mensagens | Mensagem[] | Uma matriz não vazia contendo até 500 mensagens. |
| dryRun | booleano | Define se as mensagens serão enviadas no modo de simulação (somente validação). |
Retorna:
Promessa<BatchResponse>
Uma promessa cumprida com um objeto que representa o resultado da operação de envio.
Messaging.sendeach()
Envia cada mensagem na matriz especificada pelo Firebase Cloud Messaging.
Ao contrário de Messaging.sendAll(), esse método faz uma única chamada RPC para cada mensagem na matriz especificada.
A lista de respostas recebida do valor de retorno corresponde à ordem de messages. Um erro desse método ou uma BatchResponse com todas as falhas indica uma falha total, ou seja, nenhuma das mensagens da lista foi enviada. Falhas parciais ou nenhuma falha são indicadas apenas por um valor de retorno BatchResponse.
Assinatura:
sendEach(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| mensagens | Mensagem[] | Uma matriz não vazia contendo até 500 mensagens. |
| dryRun | booleano | Define se as mensagens serão enviadas no modo de simulação (somente validação). |
Retorna:
Promessa<BatchResponse>
Uma promessa cumprida com um objeto que representa o resultado da operação de envio.
Messaging.sendCadaForMulticast()
Envia a mensagem multicast especificada para todos os tokens de registro do FCM especificados nela.
Esse método usa a API Messaging.sendevery() em segundo plano para enviar a mensagem especificada a todos os destinatários de destino. A lista de respostas recebida do valor de retorno corresponde à ordem dos tokens em MulticastMessage. Um erro desse método ou de uma BatchResponse com todas as falhas indica uma falha total, o que significa que as mensagens da lista podem ser enviadas. Falhas parciais ou falhas são indicadas apenas por um valor de retorno BatchResponse.
Assinatura:
sendEachForMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| mensagem | MulticastMessage (em inglês) | Uma mensagem multicast contendo até 500 tokens. |
| dryRun | booleano | Indica se a mensagem será enviada no modo de simulação (somente validação). |
Retorna:
Promessa<BatchResponse>
Uma promessa cumprida com um objeto que representa o resultado da operação de envio.
Messaging.sendMulticast().
Como alternativa, use Messaging.sendeveryForMulticast().
Envia a mensagem multicast especificada para todos os tokens de registro do FCM especificados nela.
Esse método usa a API sendAll() em segundo plano para enviar a mensagem fornecida a todos os destinatários de destino. A lista de respostas recebida do valor de retorno corresponde à ordem dos tokens em MulticastMessage. Um erro desse método indica uma falha total, ou seja, a mensagem não foi enviada a nenhum dos tokens da lista. Falhas parciais são indicadas por um valor de retorno BatchResponse.
Assinatura:
sendMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| mensagem | MulticastMessage (em inglês) | Uma mensagem multicast contendo até 500 tokens. |
| dryRun | booleano | Indica se a mensagem será enviada no modo de simulação (somente validação). |
Retorna:
Promessa<BatchResponse>
Uma promessa cumprida com um objeto que representa o resultado da operação de envio.
Messaging.sendToCondition().
Use Messaging.send().
Envia uma mensagem do FCM para uma condição.
Consulte Enviar para uma condição para ver exemplos de código e documentação detalhada.
Assinatura:
sendToCondition(condition: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingConditionResponse>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| transição | string | A condição que determina para quais tópicos enviar a mensagem. |
| payload | MessagingPayload (em inglês) | O payload da mensagem. |
| options | MessagingOptions (em inglês) | Opções opcionais para alterar a mensagem. |
Retorna:
Promessa<MessagingConditionResponse>
Uma promessa cumprida com a resposta do servidor após o envio da mensagem.
Messaging.sendToDevice().
Use Messaging.send().
Envia uma mensagem do FCM para um único dispositivo correspondente ao token de registro fornecido.
Consulte Enviar para dispositivos individuais para ver exemplos de código e documentação detalhada. Usa um registrationToken para enviar a um único dispositivo ou um parâmetro registrationTokens que contém uma matriz de tokens para enviar a vários dispositivos.
Assinatura:
sendToDevice(registrationTokenOrTokens: string | string[], payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDevicesResponse>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| loggingTokenOrTokens | string | string[] | |
| payload | MessagingPayload (em inglês) | O payload da mensagem. |
| options | MessagingOptions (em inglês) | Opções opcionais para alterar a mensagem. |
Retorna:
Promessa<MessagingDevicesResponse>
Uma promessa cumprida com a resposta do servidor após o envio da mensagem.
Messaging.sendToDeviceGroup()
Use Messaging.send().
Envia uma mensagem do FCM para um grupo de dispositivos correspondente à chave de notificação fornecida.
Consulte Enviar para um grupo de dispositivos para ver exemplos de código e documentação detalhada.
Assinatura:
sendToDeviceGroup(notificationKey: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDeviceGroupResponse>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| Tecla de notificação | string | A chave de notificação do grupo de dispositivos para o qual enviar a mensagem. |
| payload | MessagingPayload (em inglês) | O payload da mensagem. |
| options | MessagingOptions (em inglês) | Opções opcionais para alterar a mensagem. |
Retorna:
Promessa<MessagingDeviceGroupResponse>
Uma promessa cumprida com a resposta do servidor após o envio da mensagem.
Messaging.sendToTopic()
Use Messaging.send().
Envia uma mensagem do FCM para um tópico.
Consulte Enviar para um tópico para ver exemplos de código e documentação detalhada.
Assinatura:
sendToTopic(topic: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingTopicResponse>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| topic | string | O tópico para o qual enviar a mensagem. |
| payload | MessagingPayload (em inglês) | O payload da mensagem. |
| options | MessagingOptions (em inglês) | Opções opcionais para alterar a mensagem. |
Retorna:
Promessa<MessagingTopicResponse>
Uma promessa cumprida com a resposta do servidor após o envio da mensagem.
Messaging.subscribeToTopic()
Inscreve um dispositivo em um tópico do FCM.
Consulte Assinar um tópico para ver exemplos de código e documentação detalhada. Opcionalmente, você pode fornecer uma matriz de tokens para assinar vários dispositivos.
Assinatura:
subscribeToTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| loggingTokenOrTokens | string | string[] | |
| topic | string | O tópico em que se inscrever. |
Retorna:
Promessa<MessagingTopicManagementResponse>
Uma promessa cumprida com a resposta do servidor após a inscrição do dispositivo no tópico.
Messaging.unsubscribeFromTopic()
Faz a inscrição de um dispositivo em um tópico do FCM.
Consulte Cancelar inscrição em um tópico para ver exemplos de código e documentação detalhada. Opcionalmente, você pode fornecer uma matriz de tokens para cancelar a inscrição de vários dispositivos.
Assinatura:
unsubscribeFromTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| loggingTokenOrTokens | string | string[] | |
| topic | string | O tema no qual cancelar a inscrição. |
Retorna:
Promessa<MessagingTopicManagementResponse>
Uma promessa cumprida com a resposta do servidor após o cancelamento da inscrição do dispositivo no tópico.