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 |
|---|---|
| FirebaseMessagingError | Estructura del código de error de Firebase Messaging. Esto extiende PrefixedFirebaseError. |
| Mensajes | Servicio de mensajería vinculado a la app proporcionada. |
| MessagingClientErrorCode. | Códigos de error del cliente de mensajería y sus mensajes predeterminados |
Interfaces
| Interfaz | Descripción |
|---|---|
| AndroidConfig | Representa las opciones específicas de Android que se pueden incluir en un Message. |
| AndroidFcmOptions | Representa las opciones de funciones que proporciona el SDK de FCM para Android. |
| Notificación de Android | Representa las opciones de notificación específicas de Android que se pueden incluir en AndroidConfig. |
| ApnsConfig | Representa las opciones específicas de APNS que se pueden incluir en un Message. Consulta la documentación de Apple para conocer los diversos encabezados y campos de carga útil compatibles con APNS. |
| ApnsFcmOptions | Representa las opciones de las funciones que proporciona el SDK de FCM para iOS. |
| ApnsPayload | Representa la carga útil de un mensaje de APNS. Consta principalmente del diccionario aps. Pero también puede contener otras claves personalizadas arbitrarias. |
| Apps | Representa el diccionario de Aps que forma parte de los mensajes de APNS. |
| ApsAlert | |
| 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 una carga útil de 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. Las claves y los valores deben ser cadenas. Las claves pueden ser cualquier string personalizada, excepto las siguientes strings reservadas:
|
| FcmOptions | Se representan opciones independientes de la plataforma para funciones proporcionadas por los SDK de FCM. |
| Configuración de la luz | Representa la configuración para controlar el LED de notificaciones que se puede incluir en AndroidNotification. |
| MessagingConditionResponse | Interfaz que representa la respuesta del servidor del método heredado Messaging.sendToCondition().Consulta Enviar a una condición para ver muestras de código y documentación detallada. |
| MessagingDeviceGroupResponse | Interfaz que representa la respuesta del servidor del 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 a través de las APIs heredadas de FCM.Consulta Cómo enviar a dispositivos individuales para ver muestras de código y documentación detallada. |
| Opciones de mensajería | Interfaz que representa las opciones que se pueden proporcionar al enviar un mensaje mediante las APIs heredadas de FCM.Consulta Cómo crear solicitudes de envío para ver 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 crear solicitudes de envío para ver 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 del método heredado Messaging.sendToTopic().Consulta Envía 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 Mensaje. |
| 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 crear solicitudes de envío para ver 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 Message. |
| WebpushFcmOptions | Representa las opciones de las funciones que proporciona el SDK de FCM para la Web (que no forman parte del estándar de Webpush). |
| WebpushNotification | Representa las opciones de notificación específicas de WebPush que se pueden incluir en WebpushConfig. Esto es compatible con la mayoría de las opciones estándar que se definen en la especificación de notificaciones 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 token, tema o condició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.
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. |
Muestra:
El servicio Messaging predeterminado si no se proporciona ninguna app, o bien 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 token, tema o condición.
Firma:
export type Message = TokenMessage | TopicMessage | ConditionMessage;