Messaging class

Servicio de mensajería vinculado a la aplicación proporcionada.

Firma:

export declare class Messaging 

Propiedades

Propiedad modificadores Tipo Descripción
aplicación aplicación La aplicación asociada con la instancia del servicio Messaging actual.

Métodos

Método Modificadores Descripción
enviar (mensaje, dryRun) Envía el mensaje dado a través de FCM.
enviarTodo(mensajes, dryRun) Envía todos los mensajes en la matriz dada a través de Firebase Cloud Messaging. Emplea procesamiento por lotes para enviar la lista completa como una sola llamada RPC. Comparado con el método send() , este método es una forma significativamente más eficiente de enviar varios mensajes. La lista de respuestas obtenida del valor de retorno corresponde al orden de los tokens en MulticastMessage . Un error de este método indica una falla total, lo que significa que no se pudo enviar ninguno de los mensajes de la lista. Los errores parciales se indican mediante un valor de retorno BatchResponse .
sendEach(mensajes, dryRun) Envía cada mensaje en la matriz dada a través de Firebase Cloud Messaging. A diferencia de Mensajería.sendAll() , este método realiza una sola llamada RPC para cada mensaje en la matriz dada. La lista de respuestas obtenida del valor de retorno corresponde al orden de messages . Un error de este método o un BatchResponse con todos los errores indica un error total, lo que significa que no se pudo enviar ninguno de los mensajes de la lista. Los errores parciales o la ausencia de errores solo se indican mediante un valor de retorno BatchResponse .
sendEachForMulticast (mensaje, dryRun) Envía el mensaje de multidifusión dado a todos los tokens de registro de FCM especificados en él. Este método utiliza la API Messaging.sendEach() bajo el capó para enviar el mensaje dado a todos los destinatarios de destino. La lista de respuestas obtenida del valor de retorno corresponde al orden de los tokens en MulticastMessage . Un error de este método o un BatchResponse con todos los errores indica un error total, lo que significa que los mensajes de la lista podrían enviarse. Las fallas parciales o las fallas solo se indican mediante un valor de retorno BatchResponse .
enviarMultidifusión(mensaje, dryRun) Envía el mensaje de multidifusión dado a todos los tokens de registro de FCM especificados en él. Este método utiliza la API sendAll() bajo el capó para enviar el mensaje dado a todos los destinatarios de destino. La lista de respuestas obtenida del valor de retorno corresponde al orden de los tokens en MulticastMessage . Un error de este método indica una falla total, lo que significa que el mensaje no se envió a ninguno de los tokens de la lista. Los errores parciales se indican mediante un valor de retorno BatchResponse .
sendToCondition(condición, carga útil, opciones) Envía un mensaje FCM a una condición. Consulte Enviar a una condición para ver ejemplos de código y documentación detallada.
sendToDevice(registroTokenOrTokens, carga útil, opciones) Envía un mensaje FCM a un único dispositivo correspondiente al token de registro proporcionado. Consulte Enviar a dispositivos individuales para ver ejemplos de códigos y documentación detallada. Toma un registrationToken para enviar a un solo dispositivo o un parámetro registrationTokens que contiene una matriz de tokens para enviar a varios dispositivos.
sendToDeviceGroup (clave de notificación, carga útil, opciones) Envía un mensaje FCM a un grupo de dispositivos correspondiente a la clave de notificación proporcionada. Consulte Enviar a un grupo de dispositivos para ver ejemplos de código y documentación detallada.
sendToTopic(tema, carga útil, opciones) Envía un mensaje de FCM a un tema. Consulte Enviar a un tema para ver ejemplos de código y documentación detallada.
subscribeToTopic(registroTokenOrTokens, tema) Suscribe un dispositivo a un tema de FCM. Consulte Suscribirse a un tema para ver ejemplos de código y documentación detallada. Opcionalmente, puede proporcionar una variedad de tokens para suscribir varios dispositivos.
cancelar la suscripción del tema (token de registro o tokens, tema) Da de baja un dispositivo de un tema de FCM. Consulte Darse de baja de un tema para obtener ejemplos de código y documentación detallada. Opcionalmente, puede proporcionar una variedad de tokens para cancelar la suscripción de varios dispositivos.

Mensajería.aplicación

La aplicación asociada con la instancia del servicio Messaging actual.

Firma:

get app(): App;

Ejemplo

var app = messaging.app;

Mensajería.send()

Envía el mensaje dado a través de FCM.

Firma:

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

Parámetros

Parámetro Tipo Descripción
mensaje Mensaje La carga del mensaje.
ejecutar en seco booleano Si enviar el mensaje en el modo de prueba (solo validación).

Devoluciones:

Promesa <cadena>

Una promesa cumplida con una cadena de ID de mensaje única después de que el mensaje se haya entregado correctamente al servicio FCM para su entrega.

Mensajería.sendAll()

Utilice Messaging.sendEach() en su lugar.

Envía todos los mensajes en la matriz dada a través de Firebase Cloud Messaging. Emplea procesamiento por lotes para enviar la lista completa como una sola llamada RPC. Comparado con el método send() , este método es una forma significativamente más eficiente de enviar varios mensajes.

La lista de respuestas obtenida del valor de retorno corresponde al orden de los tokens en MulticastMessage . Un error de este método indica una falla total, lo que significa que no se pudo enviar ninguno de los mensajes de la lista. Los errores parciales se indican mediante un valor de retorno BatchResponse .

Firma:

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

Parámetros

Parámetro Tipo Descripción
mensajes Mensaje [] Una matriz no vacía que contiene hasta 500 mensajes.
ejecutar en seco booleano Si enviar los mensajes en el modo de prueba (solo validación).

Devoluciones:

Promesa< Respuesta por lotes >

Promesa cumplida con un objeto que representa el resultado de la operación de envío.

Mensajería.sendEach()

Envía cada mensaje en la matriz dada a través de Firebase Cloud Messaging.

A diferencia de Mensajería.sendAll() , este método realiza una sola llamada RPC para cada mensaje en la matriz dada.

La lista de respuestas obtenida del valor de retorno corresponde al orden de messages . Un error de este método o un BatchResponse con todos los errores indica un error total, lo que significa que no se pudo enviar ninguno de los mensajes de la lista. Los errores parciales o la ausencia de errores solo se indican mediante un valor de retorno BatchResponse .

Firma:

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

Parámetros

Parámetro Tipo Descripción
mensajes Mensaje [] Una matriz no vacía que contiene hasta 500 mensajes.
ejecutar en seco booleano Si enviar los mensajes en el modo de prueba (solo validación).

Devoluciones:

Promesa< Respuesta por lotes >

Promesa cumplida con un objeto que representa el resultado de la operación de envío.

Mensajería.sendEachForMulticast()

Envía el mensaje de multidifusión dado a todos los tokens de registro de FCM especificados en él.

Este método utiliza la API Messaging.sendEach() bajo el capó para enviar el mensaje dado a todos los destinatarios de destino. La lista de respuestas obtenida del valor de retorno corresponde al orden de los tokens en MulticastMessage . Un error de este método o un BatchResponse con todos los errores indica un error total, lo que significa que los mensajes de la lista podrían enviarse. Las fallas parciales o las fallas solo se indican mediante un valor de retorno BatchResponse .

Firma:

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

Parámetros

Parámetro Tipo Descripción
mensaje MultidifusiónMensaje Un mensaje de multidifusión que contiene hasta 500 tokens.
ejecutar en seco booleano Si enviar el mensaje en el modo de prueba (solo validación).

Devoluciones:

Promesa< Respuesta por lotes >

Promesa cumplida con un objeto que representa el resultado de la operación de envío.

Mensajería.sendMulticast()

Utilice Messaging.sendEachForMulticast() en su lugar.

Envía el mensaje de multidifusión dado a todos los tokens de registro de FCM especificados en él.

Este método utiliza la API sendAll() bajo el capó para enviar el mensaje dado a todos los destinatarios de destino. La lista de respuestas obtenida del valor de retorno corresponde al orden de los tokens en MulticastMessage . Un error de este método indica una falla total, lo que significa que el mensaje no se envió a ninguno de los tokens de la lista. Los errores parciales se indican mediante un valor de retorno BatchResponse .

Firma:

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

Parámetros

Parámetro Tipo Descripción
mensaje MultidifusiónMensaje Un mensaje de multidifusión que contiene hasta 500 tokens.
ejecutar en seco booleano Si enviar el mensaje en el modo de prueba (solo validación).

Devoluciones:

Promesa< Respuesta por lotes >

Promesa cumplida con un objeto que representa el resultado de la operación de envío.

Mensajería.sendToCondition()

Envía un mensaje FCM a una condición.

Consulte Enviar a una condición para ver ejemplos de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
condición cadena La condición que determina a qué temas enviar el mensaje.
carga útil MensajeríaCarga útil La carga del mensaje.
opciones MensajeríaOpciones Opciones opcionales para modificar el mensaje.

Devoluciones:

Promesa< MensajeríaCondiciónRespuesta >

Una promesa cumplida con la respuesta del servidor después de haber enviado el mensaje.

Mensajería.sendToDevice()

Utilice Messaging.send() en su lugar.

Envía un mensaje FCM a un único dispositivo correspondiente al token de registro proporcionado.

Consulte Enviar a dispositivos individuales para ver ejemplos de código y documentación detallada. Toma un registrationToken para enviar a un solo dispositivo o un parámetro registrationTokens que contiene una matriz de tokens para enviar a varios dispositivos.

Firma:

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

Parámetros

Parámetro Tipo Descripción
registroTokenOrTokens cadena | cadena[]
carga útil MensajeríaCarga útil La carga del mensaje.
opciones MensajeríaOpciones Opciones opcionales para modificar el mensaje.

Devoluciones:

Promesa< MensajeríaDispositivosRespuesta >

Una promesa cumplida con la respuesta del servidor después de haber enviado el mensaje.

Mensajería.sendToDeviceGroup()

Utilice Messaging.send() en su lugar.

Envía un mensaje FCM a un grupo de dispositivos correspondiente a la clave de notificación proporcionada.

Consulte Enviar a un grupo de dispositivos para ver ejemplos de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
clave de notificación cadena La clave de notificación para el grupo de dispositivos al que enviar el mensaje.
carga útil MensajeríaCarga útil La carga del mensaje.
opciones MensajeríaOpciones Opciones opcionales para modificar el mensaje.

Devoluciones:

Promise< MessagingDeviceGroupResponse >

Una promesa cumplida con la respuesta del servidor después de haber enviado el mensaje.

Mensajería.sendToTopic()

Envía un mensaje de FCM a un tema.

Consulte Enviar a un tema para ver ejemplos de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
tema cadena El tema al que enviar el mensaje.
carga útil MensajeríaCarga útil La carga del mensaje.
opciones MensajeríaOpciones Opciones opcionales para modificar el mensaje.

Devoluciones:

Promesa< MensajeríaTemaRespuesta >

Una promesa cumplida con la respuesta del servidor después de haber enviado el mensaje.

Mensajería.subscribeToTopic()

Suscribe un dispositivo a un tema de FCM.

Consulte Suscribirse a un tema para ver ejemplos de código y documentación detallada. Opcionalmente, puede proporcionar una variedad de tokens para suscribir varios dispositivos.

Firma:

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

Parámetros

Parámetro Tipo Descripción
registroTokenOrTokens cadena | cadena[]
tema cadena El tema al que suscribirse.

Devoluciones:

Promise< MensajeríaTopicManagementResponse >

Una promesa cumplida con la respuesta del servidor después de que el dispositivo se haya suscrito al tema.

Mensajería.unsubscribeFromTopic()

Da de baja un dispositivo de un tema de FCM.

Consulte Darse de baja de un tema para obtener ejemplos de código y documentación detallada. Opcionalmente, puede proporcionar una variedad de tokens para cancelar la suscripción de varios dispositivos.

Firma:

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

Parámetros

Parámetro Tipo Descripción
registroTokenOrTokens cadena | cadena[]
tema cadena El tema del que darse de baja.

Devoluciones:

Promise< MensajeríaTopicManagementResponse >

Una promesa cumplida con la respuesta del servidor después de que el dispositivo se haya dado de baja del tema.