Messaging class

Servicio de mensajería vinculado a la app proporcionada.

Firma:

export declare class Messaging

Propiedades

Propiedad Teclas modificadoras Tipo Descripción
app App La App asociada con la instancia de servicio Messaging actual.

Métodos

Método Teclas modificadoras Descripción
enableLegacyHttpTransport() Habilita el uso del transporte HTTP/1.1 heredado para sendEach() y sendEachForMulticast().
send(mensaje, DricRun) Envía el mensaje entregado a través de FCM.
sendAll(messages, DricRun) Envía todos los mensajes del array determinado a través de Firebase Cloud Messaging. Emplea el procesamiento por lotes para enviar la lista completa como una sola llamada RPC. En comparación con el método send(), este método es significativamente más eficiente para enviar múltiples mensajes.La lista de respuestas obtenida a partir del valor que se muestra 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. Las fallas parciales se indican con un valor que se muestra de BatchResponse.
sendCada(mensajes, DryRun) Envía cada mensaje del array determinado a través de Firebase Cloud Messaging.A diferencia de Messaging.sendAll(), este método realiza una sola llamada RPC para cada mensaje del array especificado.La lista de respuestas obtenida del valor que se muestra corresponde al orden de messages. Un error de este método o una BatchResponse con todos los errores indica una falla total, lo que significa que no se pudo enviar ninguno de los mensajes de la lista. Las fallas parciales o ninguna falla solo se indican mediante un valor que se muestra de BatchResponse.
sendEachForMulticast(mensaje, DryRun) Envía el mensaje multidifusión proporcionado a todos los tokens de registro de FCM que se especifican en él.Este método usa la API Messaging.sendEach() interna para enviar el mensaje determinado a todos los destinatarios de destino. La lista de respuestas obtenida del valor que se muestra corresponde al orden de los tokens en MulticastMessage. Un error de este método o una BatchResponse con todos los errores indica una falla total, lo que significa que los mensajes de la lista podrían enviarse. Las fallas parciales o las fallas solo se indican con un valor que se muestra de BatchResponse.
sendMulticast(message, sampleRun) Envía el mensaje multidifusión proporcionado a todos los tokens de registro de FCM que se especifican en él.Este método usa la API de sendAll() de forma interna para enviar el mensaje determinado a todos los destinatarios de destino. La lista de respuestas obtenida del valor que se muestra corresponde al orden de los tokens en MulticastMessage. Un error de este método indica un error total, lo que significa que el mensaje no se envió a ninguno de los tokens de la lista. Las fallas parciales se indican con un valor que se muestra de BatchResponse.
sendToCondition(condición, carga útil, opciones) Envía un mensaje de FCM a una condición.Consulta Envía a una condición para ver muestras de código y documentación detallada.
sendToDevice(registrationTokenOrTokens, carga útil, opciones) Envía un mensaje de FCM a un solo dispositivo que corresponde al token de registro proporcionado.Consulta Cómo enviar a dispositivos individuales para ver muestras de código y documentación detallada. Toma un registrationToken para enviar a un solo dispositivo o un parámetro registrationTokens que contenga un array de tokens para enviar a varios dispositivos.
sendToDeviceGroup(notificationKey, carga útil, opciones) Envía un mensaje de FCM a un grupo de dispositivos que corresponde a la clave de notificación proporcionada.Consulta Enviar a un grupo de dispositivos para ver muestras de código y documentación detallada.
sendToTopic(tema, carga útil, opciones) Envía un mensaje de FCM a un tema.Consulta Envía a un tema para ver muestras de código y documentación detallada.
subscribeToTopic(registrationTokenOrTokens, tema) Suscribe un dispositivo a un tema de FCM.Consulta Suscríbete a un tema para ver muestras de código y documentación detallada. De manera opcional, puedes proporcionar un array de tokens para suscribir varios dispositivos.
unsubscribeFromTopic(registrationTokenOrTokens, topic) Anula la suscripción de un dispositivo a un tema de FCM.Consulta Cómo anular la suscripción a un tema para ver muestras de código y documentación detallada. De forma opcional, puedes proporcionar un array de tokens para anular la suscripción de varios dispositivos.

Mensajes.app

La App asociada con la instancia de servicio Messaging actual.

Firma:

get app(): App;

Ejemplo

var app = messaging.app;

Messaging.enableLegacyHttpTransport()

Esto se quitará cuando la implementación de transporte de HTTP/2 alcance la misma estabilidad que la implementación de HTTP/1.1 heredada.

Habilita el uso del transporte HTTP/1.1 heredado para sendEach() y sendEachForMulticast().

Firma:

enableLegacyHttpTransport(): void;

Muestra:

void

Ejemplo

const messaging = getMessaging(app);
messaging.enableLegacyTransport();
messaging.sendEach(messages);

Messaging.send()

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

Firma:

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

Parámetros

Parámetro Tipo Descripción
mensaje Mensaje Es la carga útil del mensaje.
ejecución de prueba booleano Indica si se debe enviar el mensaje en modo de prueba de validación (solo validación).

Muestra:

Promesa<string>

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

Messaging.sendAll()

En su lugar, usa Messaging.sendEach().

Envía todos los mensajes del array determinado a través de Firebase Cloud Messaging. Emplea el procesamiento por lotes para enviar la lista completa como una sola llamada RPC. En comparación con el método send(), este método es mucho más eficiente de enviar varios mensajes.

La lista de respuestas obtenida del valor que se muestra 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. Las fallas parciales se indican con un valor que se muestra de BatchResponse.

Firma:

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

Parámetros

Parámetro Tipo Descripción
mensajes Mensaje Un array no vacío que contiene hasta 500 mensajes.
ejecución de prueba booleano Indica si se deben enviar los mensajes en modo de prueba de validación (solo validación).

Muestra:

Promesa<BatchResponse>

Una promesa completada con un objeto que representa el resultado de la operación de envío.

Messaging.sendEach()

Envía cada mensaje del array determinado a través de Firebase Cloud Messaging.

A diferencia de Messaging.sendAll(), este método realiza una sola llamada RPC para cada mensaje del array dado.

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

Firma:

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

Parámetros

Parámetro Tipo Descripción
mensajes Mensaje Un array no vacío que contiene hasta 500 mensajes.
ejecución de prueba booleano Indica si se deben enviar los mensajes en modo de prueba de validación (solo validación).

Muestra:

Promesa<BatchResponse>

Una promesa completada con un objeto que representa el resultado de la operación de envío.

Messaging.sendEachForMulticast()

Envía el mensaje multidifusión proporcionado a todos los tokens de registro de FCM que se especificaron en él.

Este método usa la API Messaging.sendEach() de forma interna para enviar el mensaje determinado a todos los destinatarios objetivo. La lista de respuestas obtenida del valor que se muestra corresponde al orden de los tokens en MulticastMessage. Un error de este método o una BatchResponse con todos los errores indica una falla total, lo que significa que los mensajes de la lista podrían enviarse. Las fallas parciales o las fallas solo se indican con un valor que se muestra de BatchResponse.

Firma:

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

Parámetros

Parámetro Tipo Descripción
mensaje MulticastMessage Un mensaje multicast que contiene hasta 500 tokens.
ejecución de prueba booleano Indica si se debe enviar el mensaje en modo de prueba de validación (solo validación).

Muestra:

Promesa<BatchResponse>

Una promesa completada con un objeto que representa el resultado de la operación de envío.

Messaging.sendMulticast()

En su lugar, usa Messaging.sendEachForMulticast().

Envía el mensaje multidifusión proporcionado a todos los tokens de registro de FCM que se especificaron en él.

Este método usa la API de sendAll() de forma interna para enviar el mensaje determinado a todos los destinatarios objetivo. La lista de respuestas obtenida del valor que se muestra corresponde al orden de los tokens en MulticastMessage. Un error de este método indica un error total, lo que significa que el mensaje no se envió a ninguno de los tokens de la lista. Las fallas parciales se indican con un valor que se muestra de BatchResponse.

Firma:

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

Parámetros

Parámetro Tipo Descripción
mensaje MulticastMessage Un mensaje multicast que contiene hasta 500 tokens.
ejecución de prueba booleano Indica si se debe enviar el mensaje en modo de prueba de validación (solo validación).

Muestra:

Promesa<BatchResponse>

Una promesa completada con un objeto que representa el resultado de la operación de envío.

Messaging.sendToCondition()

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

Consulta Envía a una condición para ver muestras de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
de transición string La condición que determina a qué temas enviar el mensaje.
carga útil MessagingPayload. Es la carga útil del mensaje.
opciones Opciones de mensajería Son las opciones opcionales para modificar el mensaje.

Muestra:

Promesa<MessagingConditionResponse>

Una promesa cumplida con la respuesta del servidor después de que se envió el mensaje.

Messaging.sendToDevice()

En su lugar, usa Messaging.send().

Envía un mensaje de FCM a un solo dispositivo que corresponde al token de registro proporcionado.

Consulta Enviar a dispositivos individuales para ver muestras de código y documentación detallada. Toma un registrationToken para enviar a un solo dispositivo o un parámetro registrationTokens que contenga un array 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
loggingTokenOrTokens cadena | cadena
carga útil MessagingPayload. Es la carga útil del mensaje.
opciones Opciones de mensajería Son las opciones opcionales para modificar el mensaje.

Muestra:

Promesa<MessagingDevicesResponse>

Una promesa cumplida con la respuesta del servidor después de que se envió el mensaje.

Messaging.sendToDeviceGroup()

En su lugar, usa Messaging.send().

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

Consulta Envía a un grupo de dispositivos para ver muestras de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
Clavedenotificación string La clave de notificación del grupo de dispositivos al que se envía el mensaje.
carga útil MessagingPayload. Es la carga útil del mensaje.
opciones Opciones de mensajería Son las opciones opcionales para modificar el mensaje.

Muestra:

Promesa<MessagingDeviceGroupResponse>

Una promesa cumplida con la respuesta del servidor después de que se envió el mensaje.

Messaging.sendToTopic()

Envía un mensaje de FCM a un tema.

Consulta Enviar a un tema para ver muestras 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 string El tema al que se envía el mensaje.
carga útil MessagingPayload. Es la carga útil del mensaje.
opciones Opciones de mensajería Son las opciones opcionales para modificar el mensaje.

Muestra:

Promesa<MessagingTopicResponse>

Una promesa cumplida con la respuesta del servidor después de que se envió el mensaje.

Messaging.subscribeToTopic()

Suscribe un dispositivo a un tema de FCM.

Consulta Suscríbete a un tema para ver muestras de código y documentación detallada. De manera opcional, puedes proporcionar un array de tokens para suscribir varios dispositivos.

Firma:

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

Parámetros

Parámetro Tipo Descripción
loggingTokenOrTokens cadena | cadena
tema string El tema al que se suscribe.

Muestra:

Promesa<MessagingTopicManagementResponse>

Una promesa que se cumple con la respuesta del servidor después de que el dispositivo se suscribió al tema.

Messaging.unsubscribeFromTopic()

Anula la suscripción de un dispositivo a un tema de FCM.

Consulta Anular la suscripción a un tema para ver muestras de código y documentación detallada. De manera opcional, puedes proporcionar un array de tokens para anular la suscripción de varios dispositivos.

Firma:

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

Parámetros

Parámetro Tipo Descripción
loggingTokenOrTokens cadena | cadena
tema string El tema al que se anula la suscripción.

Muestra:

Promesa<MessagingTopicManagementResponse>

Una promesa que se cumple con la respuesta del servidor después de que se anuló la suscripción del dispositivo al tema.