Messaging class

Serviço de mensagens vinculado ao aplicativo fornecido.

Assinatura:

export declare class Messaging 

Propriedades

Propriedade Modificadores Tipo Descrição
aplicativo Aplicativo O aplicativo associado à instância atual do serviço Messaging .

Métodos

Método Modificadores Descrição
send(mensagem, dryRun) Envia a mensagem dada via FCM.
sendAll(mensagens, dryRun) Envia todas as mensagens no array fornecido via Firebase Cloud Messaging. Emprega lotes para enviar a lista inteira como uma única chamada RPC. Comparado ao método send() , esse método é uma maneira significativamente mais eficiente de enviar várias mensagens. A lista de respostas obtida do valor de retorno corresponde à ordem dos tokens no MulticastMessage . Um erro desse método indica uma falha total, o que significa que nenhuma das mensagens da lista pôde ser enviada. Falhas parciais são indicadas por um valor de retorno BatchResponse .
sendEach(mensagens, dryRun) Envia cada mensagem no array fornecido via 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 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, significando 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 .
sendEachForMulticast(mensagem, dryRun) Envia a mensagem multicast fornecida para todos os tokens de registro FCM especificados nela. Esse método usa a API Messaging.sendEach() sob o capô para enviar a mensagem fornecida a todos os destinatários de destino. 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, significando que as mensagens da lista poderiam ser enviadas. Falhas parciais ou falhas são indicadas apenas por um valor de retorno BatchResponse .
sendMulticast(mensagem, dryRun) Envia a mensagem multicast fornecida para todos os tokens de registro FCM especificados nela. Esse método usa a API sendAll() sob o capô para enviar a mensagem fornecida a todos os destinatários de destino. A lista de respostas obtida do valor de retorno corresponde à ordem dos tokens no MulticastMessage . Um erro desse método indica uma falha total, significando que a mensagem não foi enviada para nenhum dos tokens da lista. Falhas parciais são indicadas por um valor de retorno BatchResponse .
sendToCondition(condição, payload, opções) Envia uma mensagem FCM para uma condição. Consulte Enviar para uma condição para obter amostras de código e documentação detalhada.
sendToDevice(registrationTokenOrTokens, payload, opções) Envia uma mensagem FCM para um único dispositivo correspondente ao token de registro fornecido. Consulte Enviar para dispositivos individuais para obter amostras de código e documentação detalhada. Usa um registrationToken para enviar a um único dispositivo ou um parâmetro registrationTokens contendo uma matriz de tokens para enviar a vários dispositivos.
sendToDeviceGroup(notificationKey, payload, opções) Envia uma mensagem FCM para um grupo de dispositivos correspondente à chave de notificação fornecida. Consulte Enviar para um grupo de dispositivos para obter amostras de código e documentação detalhada.
sendToTopic(tópico, payload, opções) Envia uma mensagem FCM para um tópico. Consulte Enviar para um tópico para obter amostras de código e documentação detalhada.
SubscribeToTopic(registrationTokenOrTokens, tópico) Inscreve um dispositivo em um tópico FCM. Consulte Inscrever-se em um tópico para obter amostras de código e documentação detalhada. Opcionalmente, você pode fornecer uma matriz de tokens para inscrever vários dispositivos.
unsubscribeFromTopic(registrationTokenOrTokens, tópico) Cancela a assinatura de um dispositivo de um tópico FCM. Consulte Cancelar assinatura de um tópico para exemplos de código e documentação detalhada. Opcionalmente, você pode fornecer uma matriz de tokens para cancelar a assinatura de vários dispositivos.

Messaging.app

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

Assinatura:

get app(): App;

Exemplo

var app = messaging.app;

Messaging.send()

Envia a mensagem dada via FCM.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
mensagem Mensagem A carga útil da mensagem.
funcionamento a seco boleano Se a mensagem deve ser enviada no modo de teste (somente validação).

Retorna:

Promessa<string>

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

Mensagens.sendAll()

Em vez disso, use Messaging.sendEach() .

Envia todas as mensagens no array fornecido via Firebase Cloud Messaging. Emprega lotes para enviar a lista inteira como uma única chamada RPC. Comparado ao método send() , esse método é uma maneira significativamente mais eficiente de enviar várias mensagens.

A lista de respostas obtida do valor de retorno corresponde à ordem dos tokens no MulticastMessage . Um erro desse método indica uma falha total, o que significa que nenhuma das mensagens da lista pôde ser 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.
funcionamento a seco boleano Se as mensagens devem ser enviadas no modo de teste (somente validação).

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 via 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 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, significando 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

Parâmetro Tipo Descrição
mensagens Mensagem [] Uma matriz não vazia contendo até 500 mensagens.
funcionamento a seco boleano Se as mensagens devem ser enviadas no modo de teste (somente validação).

Retorna:

Promessa < BatchResponse >

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

Messaging.sendEachForMulticast()

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

Esse método usa a API Messaging.sendEach() sob o capô para enviar a mensagem fornecida a todos os destinatários de destino. 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, significando que as mensagens da lista poderiam 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 Uma mensagem multicast contendo até 500 tokens.
funcionamento a seco boleano Se a mensagem deve ser enviada no modo de teste (somente validação).

Retorna:

Promessa < BatchResponse >

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

Messaging.sendMulticast()

Em vez disso, use Messaging.sendEachForMulticast() .

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

Esse método usa a API sendAll() sob o capô para enviar a mensagem fornecida a todos os destinatários de destino. A lista de respostas obtida do valor de retorno corresponde à ordem dos tokens no MulticastMessage . Um erro desse método indica uma falha total, significando que a mensagem não foi enviada para 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 Uma mensagem multicast contendo até 500 tokens.
funcionamento a seco boleano Se a mensagem deve ser enviada no modo de teste (somente validação).

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 amostras de código e documentação detalhada.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
doença corda A condição que determina para quais tópicos enviar a mensagem.
carga útil Carga útil de mensagens A carga útil da mensagem.
opções Opções de mensagens Opções opcionais para alterar a mensagem.

Retorna:

Promise< MessagingConditionResponse >

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

Messaging.sendToDevice()

Em vez disso, use Messaging.send() .

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

Consulte Enviar para dispositivos individuais para obter amostras de código e documentação detalhada. Usa 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

Parâmetro Tipo Descrição
registroTokenOuTokens seqüência de caracteres | corda[]
carga útil Carga útil de mensagens A carga útil da mensagem.
opções Opções de mensagens 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()

Em vez disso, use Messaging.send() .

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

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

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
NotificationKey corda A chave de notificação para o grupo de dispositivos para o qual enviar a mensagem.
carga útil Carga útil de mensagens A carga útil da mensagem.
opções Opções de mensagens Opções opcionais para alterar a mensagem.

Retorna:

Promise< 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 amostras de código e documentação detalhada.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
tema corda O tópico para o qual enviar a mensagem.
carga útil Carga útil de mensagens A carga útil da mensagem.
opções Opções de mensagens Opções opcionais para alterar a mensagem.

Retorna:

Promise< MessagingTopicResponse >

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

Messaging.subscribeToTopic()

Inscreve um dispositivo em um tópico FCM.

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

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
registroTokenOuTokens seqüência de caracteres | corda[]
tema corda O tópico para o qual se inscrever.

Retorna:

Promise< MessagingTopicManagementResponse >

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

Messaging.unsubscribeFromTopic()

Cancela a assinatura de um dispositivo de um tópico FCM.

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

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
registroTokenOuTokens seqüência de caracteres | corda[]
tema corda O tópico do qual cancelar a assinatura.

Retorna:

Promise< MessagingTopicManagementResponse >

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