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 actual del servicio Messaging . |
Métodos
| Método | Modificadores | Descripción |
|---|---|---|
| enviar (mensaje, ejecución seca) | Envía el mensaje dado a través de FCM. | |
| enviarTodos(mensajes, ejecución seca) | 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 única llamada RPC. En comparación con el método send() , este método es una forma significativamente más eficiente de enviar múltiples 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 un fallo total, lo que significa que no se pudo enviar ninguno de los mensajes de la lista. Los fallos parciales se indican mediante un valor de retorno BatchResponse . | |
| enviar cada uno (mensajes, ejecución seca) | Envía cada mensaje en la matriz dada a través de Firebase Cloud Messaging. A diferencia de Messaging.sendAll() , este método realiza una única 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 fallos parciales o ningún fallo solo se indican mediante un valor de retorno BatchResponse . | |
| sendEachForMulticast(mensaje, ejecución seca) | Envía el mensaje de multidifusión proporcionado a todos los tokens de registro de FCM especificados en él. Este método utiliza la API Messaging.sendEach() internamente 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 fallos indica un fallo total, lo que significa que se pudieron enviar los mensajes de la lista. Los fallos parciales o los fallos solo se indican mediante un valor de retorno BatchResponse . | |
| enviarMultidifusión (mensaje, ejecución seca) | Envía el mensaje de multidifusión proporcionado a todos los tokens de registro de FCM especificados en él. Este método utiliza la API sendAll() internamente 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 fallos 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(registrationTokenOrTokens, carga útil, opciones) | Envía un mensaje FCM a un único dispositivo correspondiente al token de registro proporcionado. Consulte Envío a dispositivos individuales para ver ejemplos de códigos y documentación detallada. Toma un registrationToken para enviarlo a un solo dispositivo o un parámetro registrationTokens que contiene una serie de tokens para enviar a múltiples 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ódigos y documentación detallada. | |
| sendToTopic(tema, carga útil, opciones) | Envía un mensaje FCM a un tema. Consulte Enviar a un tema para ver ejemplos de código y documentación detallada. | |
| subscribeToTopic(registrationTokenOrTokens, tema) | Suscribe un dispositivo a un tema de FCM. Consulte Suscribirse a un tema para obtener ejemplos de código y documentación detallada. Opcionalmente, puede proporcionar una variedad de tokens para suscribir varios dispositivos. | |
| darse de baja de Topic(registrationTokenOrTokens, tema) | Cancela la suscripción de un dispositivo a un tema de FCM. Consulte Cancelar suscripción a 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 actual del servicio Messaging .
Firma:
get app(): App;
Ejemplo
var app = messaging.app;
Mensajería.enviar()
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 útil del mensaje. |
| ejecución seca | booleano | Si se debe enviar el mensaje en el modo de ejecución en seco (solo validación). |
Devoluciones:
Promesa<cadena>
Una promesa que se cumple 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 única llamada RPC. En comparación con el método send() , este método es una forma significativamente más eficiente de enviar múltiples 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 un fallo total, lo que significa que no se pudo enviar ninguno de los mensajes de la lista. Los fallos 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. |
| ejecución seca | booleano | Si se deben enviar los mensajes en el modo de ejecución en seco (solo validación). |
Devoluciones:
Promesa< Respuesta por lotes >
Una 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 Messaging.sendAll() , este método realiza una única 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 fallos parciales o ningún fallo 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. |
| ejecución seca | booleano | Si se deben enviar los mensajes en el modo de ejecución en seco (solo validación). |
Devoluciones:
Promesa< Respuesta por lotes >
Una 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 proporcionado a todos los tokens de registro de FCM especificados en él.
Este método utiliza la API Messaging.sendEach() internamente 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 fallos indica un fallo total, lo que significa que se pudieron enviar los mensajes de la lista. Los fallos parciales o los fallos 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 | Mensaje de multidifusión | Un mensaje de multidifusión que contiene hasta 500 tokens. |
| ejecución seca | booleano | Si se debe enviar el mensaje en el modo de ejecución en seco (solo validación). |
Devoluciones:
Promesa< Respuesta por lotes >
Una 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 proporcionado a todos los tokens de registro de FCM especificados en él.
Este método utiliza la API sendAll() internamente 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 fallos 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 | Mensaje de multidifusión | Un mensaje de multidifusión que contiene hasta 500 tokens. |
| ejecución seca | booleano | Si se debe enviar el mensaje en el modo de ejecución en seco (solo validación). |
Devoluciones:
Promesa< Respuesta por lotes >
Una 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 | Carga útil de mensajería | La carga útil del mensaje. |
| opciones | Opciones de mensajería | Opciones opcionales para modificar el mensaje. |
Devoluciones:
Promesa< MessagingConditionResponse >
Una promesa cumplida con la respuesta del servidor una vez 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 Envío a dispositivos individuales para ver ejemplos de códigos y documentación detallada. Toma un registrationToken para enviarlo a un solo dispositivo o un parámetro registrationTokens que contiene una serie de tokens para enviar a múltiples dispositivos.
Firma:
sendToDevice(registrationTokenOrTokens: string | string[], payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDevicesResponse>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| registroTokenOrTokens | cadena | cadena[] | |
| carga útil | Carga útil de mensajería | La carga útil del mensaje. |
| opciones | Opciones de mensajería | Opciones opcionales para modificar el mensaje. |
Devoluciones:
Promesa< MessagingDevicesResponse >
Una promesa cumplida con la respuesta del servidor una vez 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ódigos 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 | Carga útil de mensajería | La carga útil del mensaje. |
| opciones | Opciones de mensajería | Opciones opcionales para modificar el mensaje. |
Devoluciones:
Promesa< MessagingDeviceGroupResponse >
Una promesa cumplida con la respuesta del servidor una vez enviado el mensaje.
Mensajería.sendToTopic()
Envía un mensaje 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 | Carga útil de mensajería | La carga útil del mensaje. |
| opciones | Opciones de mensajería | Opciones opcionales para modificar el mensaje. |
Devoluciones:
Promesa < MensajeríaTemaRespuesta >
Una promesa cumplida con la respuesta del servidor una vez enviado el mensaje.
Mensajería.subscribeToTopic()
Suscribe un dispositivo a un tema de FCM.
Consulte Suscribirse a un tema para obtener 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:
Promesa< MensajeríaTemaGestiónRespuesta >
Una promesa cumplida con la respuesta del servidor después de que el dispositivo se haya suscrito al tema.
Mensajería.unsubscribeFromTopic()
Cancela la suscripción de un dispositivo a un tema de FCM.
Consulte Cancelar suscripción a 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:
Promesa< MensajeríaTemaGestiónRespuesta >
Una promesa cumplida con la respuesta del servidor después de que el dispositivo se haya dado de baja del tema.