Firebase Cloud Messaging (FCM).
Funciones
| Función | Descripción |
|---|---|
| getMessaging(app) | Obtiene el servicio de Messaging para la app predeterminada o una app determinada.Se puede llamar a admin.messaging() sin argumentos para acceder al servicio Messaging de la app predeterminada o como admin.messaging(app) para acceder al servicio Messaging asociado con una app específica. |
Clases
| Clase | Descripción |
|---|---|
| Mensajes | Servicio de mensajería vinculado a la app proporcionada. |
Interfaces
| Interfaz | Descripción |
|---|---|
| AndroidConfig | Representa las opciones específicas de Android que se pueden incluir en un Message. |
| AndroidFcmOptions. | Representa las opciones de las funciones que proporciona el SDK de FCM para Android. |
| AndroidNotification | Representa las opciones de notificación específicas de Android que se pueden incluir en AndroidConfig. |
| Configuración de la aplicación | Representa las opciones específicas de APNS que se pueden incluir en un Message. Consulta la documentación de Apple para conocer varios encabezados y campos de carga útil admitidos por APNS. |
| Opciones de ApnsFcm | Representa las opciones de las funciones que proporciona el SDK de FCM para iOS. |
| Carga útil | Representa la carga útil de un mensaje de APNS. Consiste principalmente en el diccionario aps. pero también puede contener otras claves personalizadas arbitrarias. |
| Aplicaciones | Representa el diccionario de apps que forma parte de los mensajes de APNS. |
| Alerta Aps | |
| BaseMessage | |
| BatchResponse | Interfaz que representa la respuesta del servidor de los métodos Messaging.sendAll() y Messaging.sendMulticast(). |
| ConditionMessage | |
| Sonido crítico | Representa una configuración de sonido crítica que se puede incluir en el diccionario aps de una carga útil de APNS. |
| DataMessagePayload. | Interfaz que representa la carga útil de un mensaje de datos de la API heredada de FCM. Los mensajes de datos permiten a los desarrolladores enviar hasta 4 KB de pares clave-valor personalizados. Tanto las claves como los valores deben ser strings. Las claves pueden ser cualquier cadena personalizada, excepto las siguientes cadenas reservadas:
|
| Opciones de Fcm | Representa opciones independientes de la plataforma para las funciones que proporcionan los SDK de FCM. |
| Configuración de luz | Representa la configuración para controlar el LED de notificaciones que se pueden incluir en AndroidNotification. |
| MessagingConditionResponse. | Interfaz que representa la respuesta del servidor del método Messaging.sendToCondition() heredado.Consulta Cómo enviar a una condición para ver muestras de código y documentación detallada. |
| MessagingDeviceGroupResponse. | Interfaz que representa la respuesta del servidor desde el método Messaging.sendToDeviceGroup().Consulta Cómo enviar mensajes a grupos de dispositivos para ver muestras de código y documentación detallada. |
| MessagingDeviceResult. | Carga útil de respuesta de estado individual de dispositivos individuales |
| MessagingDevicesResponse | Interfaz que representa el estado de un mensaje enviado a un dispositivo individual mediante las APIs heredadas de FCM.Consulta Enviar a dispositivos individuales para obtener muestras de código y documentación detallada. |
| Opciones de mensajería | Interfaz que representa las opciones que se pueden proporcionar cuando se envía un mensaje mediante las APIs heredadas de FCM.Consulta Cómo compilar solicitudes de envío para obtener muestras de código y documentación detallada. |
| MessagingPayload. | Interfaz que representa la carga útil de un mensaje de Firebase Cloud Messaging. Se requiere una o ambas claves data y notification.Consulta Cómo compilar solicitudes de envío para obtener muestras de código y documentación detallada. |
| MessagingTopicManagementResponse. | Interfaz que representa la respuesta del servidor de los métodos Messaging.subscribeToTopic() y Messaging.unsubscribeFromTopic().Consulta Cómo administrar temas desde el servidor para ver muestras de código y documentación detallada. |
| MessagingTopicResponse. | Interfaz que representa la respuesta del servidor desde el método heredado Messaging.sendToTopic().Consulta Cómo enviar a un tema para ver muestras de código y documentación detallada. |
| MulticastMessage | Carga útil del método Messaging.sendMulticast(). La carga útil contiene todos los campos del tipo BaseMessage y una lista de tokens. |
| Notificación | Una notificación que se puede incluir en Message. |
| NotificationMessagePayload | Interfaz que representa la carga útil de un mensaje de notificación de la API heredada de FCM. Los mensajes de notificación permiten a los desarrolladores enviar hasta 4 KB de pares clave-valor predefinidos. Las claves aceptadas se describen a continuación.Consulta Cómo compilar solicitudes de envío para obtener muestras de código y documentación detallada. |
| SendResponse | Interfaz que representa el estado de un mensaje individual que se envió como parte de una solicitud por lotes. |
| TokenMessage | |
| TopicMessage | |
| WebpushConfig | Representa las opciones del protocolo WebPush que se pueden incluir en un mensaje. |
| WebpushFcmOptions | Representa las opciones de las funciones que proporciona el SDK de FCM para la Web (que no forman parte del estándar Webpush). |
| WebpushNotification | Representa las opciones de notificación específicas de WebPush que se pueden incluir en WebpushConfig. Esto admite la mayoría de las opciones estándar que se definen en la especificación de la notificación web. |
Escribe alias
| Alias de tipo | Descripción |
|---|---|
| Mensaje | Carga útil de la operación Messaging.send(). La carga útil contiene todos los campos del tipo BaseMessage y exactamente uno de los tokens, temas o condiciones. |
getMessaging(app)
Obtiene el servicio de Messaging para la app predeterminada o una determinada.
Se puede llamar a admin.messaging() sin argumentos para acceder al servicio Messaging de la app predeterminada o como admin.messaging(app) para acceder al servicio Messaging asociado con una app específica.
Firma:
export declare function getMessaging(app?: App): Messaging;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| app | App | App opcional cuyo servicio Messaging se debe mostrar. Si no se proporciona, se mostrará el servicio Messaging predeterminado. |
Devuelve:
El servicio predeterminado Messaging si no se proporciona ninguna app o el servicio Messaging asociado con la app proporcionada
Ejemplo 1
// Get the Messaging service for the default app
const defaultMessaging = getMessaging();
Ejemplo 2
// Get the Messaging service for a given app
const otherMessaging = getMessaging(otherApp);
Mensaje
Carga útil de la operación Messaging.send(). La carga útil contiene todos los campos del tipo BaseMessage y exactamente uno de los tokens, temas o condiciones.
Firma:
export type Message = TokenMessage | TopicMessage | ConditionMessage;