Mensajería en la nube de Firebase (FCM).
Funciones
Función | Descripción |
---|---|
getMessaging (aplicación) | Obtiene el servicio de mensajería para la aplicación predeterminada o una aplicación determinada. Se puede llamar a admin.messaging() sin argumentos para acceder al servicio Messaging de la aplicación predeterminada o como admin.messaging(app) para acceder al servicio Messaging asociado con una aplicación específica. |
Clases
Clase | Descripción |
---|---|
Mensajería | Servicio de mensajería vinculado a la aplicación proporcionada. |
Interfaces
Interfaz | Descripción |
---|---|
Configuración de Android | Representa las opciones específicas de Android que se pueden incluir en un mensaje . |
AndroidFcmOpciones | Representa opciones para funciones proporcionadas por FCM SDK para Android. |
AndroidNotificación | Representa las opciones de notificación específicas de Android que se pueden incluir en AndroidConfig . |
ApnsConfig | Representa las opciones específicas de APN que se pueden incluir en un mensaje . Consulte la documentación de Apple para conocer varios encabezados y campos de carga compatibles con APN. |
ApnsFcmOpciones | Representa opciones para funciones proporcionadas por FCM SDK para iOS. |
ApnsCarga útil | Representa la carga útil de un mensaje APN. Consiste principalmente en el diccionario aps . Pero también puede contener otras claves personalizadas arbitrarias. |
aps | Representa el diccionario aps que forma parte de los mensajes APN. |
Alerta Aps | |
Mensaje base | |
Respuesta por lotes | Interfaz que representa la respuesta del servidor de los métodos Messaging.sendAll() y Messaging.sendMulticast() . |
CondiciónMensaje | |
CriticalSound | Representa una configuración de sonido crítica que se puede incluir en el diccionario aps de una carga útil de APN. |
DatosMessagePayload | Interfaz que representa una carga útil de mensaje de datos de 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 cadenas. Las claves pueden ser cualquier cadena personalizada, excepto las siguientes cadenas reservadas:
|
FcmOpciones | Representa opciones independientes de la plataforma para funciones proporcionadas por los SDK de FCM. |
Ajustes de luz | Representa la configuración para controlar el LED de notificación que se puede incluir en AndroidNotification . |
MensajeríaCondiciónRespuesta | Interfaz que representa la respuesta del servidor del método heredado Messaging.sendToCondition() . Consulte Enviar a una condición para ver ejemplos de código y documentación detallada. |
MensajeríaGrupo de dispositivosRespuesta | Interfaz que representa la respuesta del servidor del método Messaging.sendToDeviceGroup() . Consulte Enviar mensajes a grupos de dispositivos para obtener ejemplos de código y documentación detallada. |
Resultado de dispositivo de mensajería | Carga útil de respuesta de estado individual desde dispositivos individuales |
MensajeríaDispositivosRespuesta | Interfaz que representa el estado de un mensaje enviado a un dispositivo individual a través de las API heredadas de FCM. Consulte Enviar a dispositivos individuales para ver ejemplos de códigos y documentación detallada. |
MensajeríaOpciones | Interfaz que representa las opciones que se pueden proporcionar al enviar un mensaje a través de las API heredadas de FCM. Consulte Crear solicitudes de envío para obtener ejemplos de código y documentación detallada. |
MensajeríaCarga útil | Interfaz que representa una carga de mensaje de Firebase Cloud Messaging. Se requiere una o ambas claves de data y notification . Consulte Crear solicitudes de envío para obtener ejemplos de código y documentación detallada. |
MensajeríaTemaGestiónRespuesta | Interfaz que representa la respuesta del servidor de los métodos Messaging.subscribeToTopic() y Messaging.unsubscribeFromTopic() . Consulte Administrar temas desde el servidor para obtener ejemplos de código y documentación detallada. |
MensajeríaTemaRespuesta | Interfaz que representa la respuesta del servidor del método heredado Messaging.sendToTopic() . Consulte Enviar a un tema para ver ejemplos de código y documentación detallada. |
MultidifusiónMensaje | Carga útil para el 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 . |
NotificaciónMensajePayload | Interfaz que representa una carga útil de mensaje de notificación de 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. Consulte Crear solicitudes de envío para obtener ejemplos de código y documentación detallada. |
Enviar respuesta | Interfaz que representa el estado de un mensaje individual que se envió como parte de una solicitud por lotes. |
TokenMensaje | |
TemaMensaje | |
WebpushConfig | Representa las opciones del protocolo WebPush que se pueden incluir en un mensaje . |
WebpushFcmOpciones | Representa opciones para funciones proporcionadas por FCM SDK for Web (que no forman parte del estándar Webpush). |
WebpushNotificación | 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 definidas en la especificación de notificación web. . |
Tipo de alias
Alias de tipo | Descripción |
---|---|
Mensaje | Carga útil para 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()
Obtiene el servicio de mensajería para la aplicación predeterminada o una aplicación determinada.
Se puede llamar a admin.messaging()
sin argumentos para acceder al servicio Messaging
de la aplicación predeterminada o como admin.messaging(app)
para acceder al servicio Messaging
asociado con una aplicación específica.
Firma:
export declare function getMessaging(app?: App): Messaging;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
aplicación | aplicación | App opcional cuyo servicio Messaging devolver. Si no se proporciona, se devolverá el servicio Messaging predeterminado. |
Devoluciones:
El servicio Messaging
predeterminado si no se proporciona ninguna aplicación o el servicio Messaging
asociado con la aplicación 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 para 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;