Messaging class

Serviço de mensagens vinculado ao aplicativo fornecido.

Assinatura:

export declare class Messaging 

Propriedades

Métodos

Mensagens.app

O aplicativo associado à instância atual do serviço Messaging .

Assinatura:

get app(): App;

Exemplo

var app = messaging.app;

Mensagens.send()

Envia a mensagem fornecida via FCM.

Assinatura:

send(message: Message, dryRun?: boolean): Promise<string>;

Parâmetros

Retorna:

Promessa<string>

Uma promessa cumprida com uma string de ID de mensagem exclusiva depois que a mensagem foi entregue com êxito ao serviço FCM para entrega.

Mensagens.sendAll()

Use Messaging.sendEach() em vez disso.

Envia todas as mensagens no array fornecido por meio do Firebase Cloud Messaging. Emprega lote para enviar a lista inteira como uma única chamada RPC. Comparado ao método send() , este método é uma forma significativamente mais eficiente de enviar múltiplas mensagens.

A lista de respostas obtida do valor de retorno corresponde à ordem dos tokens no MulticastMessage . Um erro deste método indica uma falha total, o que significa que nenhuma das mensagens da lista pôde ser enviada. As falhas parciais são indicadas por um valor de retorno BatchResponse .

Assinatura:

sendAll(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;

Parâmetros

Retorna:

Promessa< BatchResponse >

Uma promessa cumprida com um objeto que representa o resultado da operação de envio.

Mensagens.sendEach()

Envia cada mensagem no array fornecido por meio do Firebase Cloud Messaging.

Ao contrário de Messaging.sendAll() , esse método faz uma única chamada RPC para cada mensagem no array fornecido.

A lista de respostas obtida do valor de retorno corresponde à ordem das messages . Um erro deste método ou um BatchResponse com todas as falhas indica uma falha total, o que significa que nenhuma das mensagens da lista pôde ser 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

Retorna:

Promessa< BatchResponse >

Uma promessa cumprida com um objeto que representa o resultado da operação de envio.

Mensagens.sendEachForMulticast()

Envia a mensagem multicast fornecida para todos os tokens de registro FCM especificados nela.

Este método usa a API Messaging.sendEach() nos bastidores para enviar a mensagem fornecida a todos os destinatários alvo. A lista de respostas obtida do valor de retorno corresponde à ordem dos tokens no MulticastMessage . Um erro deste método ou um 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

Retorna:

Promessa< BatchResponse >

Uma promessa cumprida com um objeto que representa o resultado da operação de envio.

Mensagens.sendMulticast()

Use Messaging.sendEachForMulticast() em vez disso.

Envia a mensagem multicast fornecida para todos os tokens de registro FCM especificados nela.

Este método usa a API sendAll() nos bastidores para enviar a mensagem fornecida a todos os destinatários alvo. A lista de respostas obtida do valor de retorno corresponde à ordem dos tokens no MulticastMessage . Um erro deste método indica uma falha total, significando que a mensagem não foi enviada para nenhum dos tokens da lista. As falhas parciais são indicadas por um valor de retorno BatchResponse .

Assinatura:

sendMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;

Parâmetros

Retorna:

Promessa< BatchResponse >

Uma promessa cumprida com um objeto que representa o resultado da operação de envio.

Mensagens.sendToCondition()

Envia uma mensagem FCM para uma condição.

Consulte Enviar para uma condição para obter exemplos de código e documentação detalhada.

Assinatura:

sendToCondition(condition: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingConditionResponse>;

Parâmetros

Retorna:

Promessa< MessagingConditionResponse >

Uma promessa cumprida com a resposta do servidor após o envio da mensagem.

Mensagens.sendToDevice()

Use Messaging.send() em vez disso.

Envia uma mensagem FCM para um único dispositivo correspondente ao token de registro fornecido.

Consulte Enviar para dispositivos individuais para obter exemplos de código e documentação detalhada. Utiliza um registrationToken para enviar a um único dispositivo ou um parâmetro registrationTokens contendo uma matriz de tokens para enviar a vários dispositivos.

Assinatura:

sendToDevice(registrationTokenOrTokens: string | string[], payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDevicesResponse>;

Parâmetros

Retorna:

Promessa< MessagingDevicesResponse >

Uma promessa cumprida com a resposta do servidor após o envio da mensagem.

Mensagens.sendToDeviceGroup()

Use Messaging.send() em vez disso.

Envia uma mensagem FCM para um grupo de dispositivos correspondente à chave de notificação fornecida.

Consulte Enviar para um grupo de dispositivos para obter exemplos de código e documentação detalhada.

Assinatura:

sendToDeviceGroup(notificationKey: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDeviceGroupResponse>;

Parâmetros

Retorna:

Promessa< MessagingDeviceGroupResponse >

Uma promessa cumprida com a resposta do servidor após o envio da mensagem.

Mensagens.sendToTopic()

Envia uma mensagem FCM para um tópico.

Consulte Enviar para um tópico para obter exemplos de código e documentação detalhada.

Assinatura:

sendToTopic(topic: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingTopicResponse>;

Parâmetros

Retorna:

Promessa< MessagingTopicResponse >

Uma promessa cumprida com a resposta do servidor após o envio da mensagem.

Mensagens.subscribeToTopic()

Inscreve um dispositivo em um tópico do FCM.

Consulte Inscrever-se em um tópico para obter exemplos de código e documentação detalhada. Opcionalmente, você pode fornecer uma série de tokens para assinar vários dispositivos.

Assinatura:

subscribeToTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

Parâmetros

Retorna:

Promessa< MessagingTopicManagementResponse >

Uma promessa cumprida com a resposta do servidor após o dispositivo ter se inscrito no tópico.

Mensagens.unsubscribeFromTopic()

Cancela a inscrição de um dispositivo em um tópico do FCM.

Consulte Cancelar assinatura de um tópico para obter exemplos de código e documentação detalhada. Opcionalmente, você pode fornecer uma série de tokens para cancelar a assinatura de vários dispositivos.

Assinatura:

unsubscribeFromTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

Parâmetros

Retorna:

Promessa< MessagingTopicManagementResponse >

Uma promessa cumprida com a resposta do servidor após o cancelamento da inscrição do dispositivo no tópico.