Representa las opciones de notificación específicas de Android que se pueden incluir en AndroidConfig.
Firma:
export interface AndroidNotification
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
| cuerpo | string | Cuerpo de la notificación de Android Cuando se proporciona, anula el cuerpo configurado a través de admin.messaging.Notification. |
| bodyLocArgs; | string[] | Es un array de claves de recursos que se usará en lugar de los especificadores de formato en bodyLocKey. |
| bodyLocKey | string | Clave de la cadena del cuerpo en el recurso de cadenas de la app que se usa para localizar el texto del cuerpo. |
| channelId | string | El ID del canal de notificaciones de Android (nuevo en Android O). La app debe crear un canal con este ID para que se pueda recibir cualquier notificación con él. Si no envías este ID de canal en la solicitud o si la app aún no crea el ID proporcionado, FCM usa el ID de canal especificado en el manifiesto de la app. |
| clickAction | string | La acción asociada con el clic de un usuario en la notificación. Si se especifica, se lanza una actividad con un filtro de intents que coincide cuando un usuario hace clic en la notificación. |
| color | string | Color del ícono de notificación en formato #rrggbb. |
| defaultLightSettings | booleano | Si la estableces como true, usa la configuración de luz LED predeterminada del framework de Android para la notificación. Los valores predeterminados se especifican en config.xml. Si default_light_settings se configura como true y también se establece light_settings, se usa el light_settings especificado por el usuario en lugar del valor predeterminado. |
| Sonido predeterminado | booleano | Si la estableces en true, usa el sonido predeterminado del framework de Android para la notificación. Los valores predeterminados se especifican en config.xml. |
| defaultVibrateTimings | booleano | Si la estableces como true, usa el patrón de vibración predeterminado del framework de Android para la notificación. Los valores predeterminados se especifican en config.xml. Si default_vibrate_timings se configura como true y también se establece vibrate_timings, se usa el valor predeterminado en lugar del vibrate_timings especificado por el usuario. |
| eventTimestamp | Fecha | En el caso de las notificaciones que informan a los usuarios sobre eventos con una referencia de tiempo absoluta, establece la hora en que ocurrió el evento en la notificación. Las notificaciones del panel se ordenan por este momento. |
| ícono | string | Recurso de ícono para la notificación de Android. |
| URLdeimagen | string | URL de la imagen que se mostrará en la notificación. |
| lightSettings | Configuración de la luz | Configuración para controlar la velocidad de intermitencia del LED de la notificación y el color si la luz LED está disponible en el dispositivo. El SO controla el tiempo total de intermitencia. |
| Solo local | booleano | Define si esta notificación es relevante solo para el dispositivo actual o no. Algunas notificaciones se pueden compartir con otros dispositivos para mostrarlas de manera remota, como un reloj Wear OS. Se puede configurar esta sugerencia para que no se transmita esta notificación. Consulta las guías de Wear OS. |
| notificationCount | número | Establece la cantidad de elementos que representa esta notificación. Se puede mostrar como un recuento de insignias para los selectores que admiten insignias. Consulta NotificationBadge. Por ejemplo, esto podría ser útil si usas una sola notificación para representar varios mensajes nuevos, pero quieres que el recuento aquí representa la cantidad total de mensajes nuevos. Si es cero o no se especifica, los sistemas que admiten insignias usan el valor predeterminado, que consiste en aumentar el número que se muestra en el menú de presión prolongada cada vez que llega una notificación nueva. |
| prioridad | ('min' | 'baja' | 'predeterminado' | 'alto' | 'max') | Establece la prioridad relativa de esta notificación. En determinadas situaciones, las notificaciones de baja prioridad pueden ocultarse para el usuario. Ten en cuenta que esta prioridad es diferente de AndroidMessagePriority. El cliente procesa esta prioridad después de que se entrega el mensaje. Por otro lado, AndroidMessagePriority es un concepto de FCM que controla cuándo se entrega el mensaje. |
| sonido | string | Nombre del archivo del sonido que se reproducirá cuando el dispositivo reciba la notificación. |
| fijo | booleano | Si la estableces como false o no la estableces, la notificación se descartará automáticamente cuando el usuario haga clic en ella, en el panel. Cuando se establece en true, la notificación persiste incluso cuando el usuario hace clic en ella. |
| etiqueta | string | Etiqueta de notificación. Es un identificador que se usa para reemplazar las notificaciones existentes en el panel lateral de notificaciones. Si no se configura, cada solicitud crea una nueva notificación. |
| cotización | string | Establece la cotización. texto, que se envía a los servicios de accesibilidad. En versiones anteriores a la API nivel 21 (Lollipop), configura el texto que se muestra en la barra de estado cuando llega la notificación por primera vez. |
| title | string | Título de la notificación de Android. Cuando se proporciona, anula el título establecido a través de admin.messaging.Notification. |
| titleLocArgs | string[] | Es un array de claves de recursos que se usará en lugar de los especificadores de formato en titleLocKey. |
| titleLocKey | string | Clave de la cadena del título en el recurso de cadenas de la app que se usa para localizar el texto del título. |
| vibrateTimingsMillis | número | Establece el patrón de vibración que se usará. Pasa una matriz de milisegundos para activar o desactivar el vibrador. El primer valor indica cuánto tiempo se debe esperar antes de activar el vibrador. El siguiente valor indica la duración que se debe mantener activada la vibración. Los valores siguientes alternan entre duración para apagar el vibrador y activarlo. Si se configura vibrate_timings y default_vibrate_timings como true, se usa el valor predeterminado en lugar del vibrate_timings especificado por el usuario. |
| visibilidad | ('privado' | 'público' | 'secreto') | Establece la visibilidad de la notificación. Debe ser private, public o secret. Si no se especifica, private se establece de forma predeterminada. |
AndroidNotification.body
Cuerpo de la notificación de Android Cuando se proporciona, anula el cuerpo configurado mediante admin.messaging.Notification.
Firma:
body?: string;
AndroidNotification.bodyLocArgs
Un array de claves de recursos que se usará en lugar de los especificadores de formato en bodyLocKey.
Firma:
bodyLocArgs?: string[];
AndroidNotification.bodyLocKey.
Clave de la cadena del cuerpo en el recurso de cadenas de la app que se usa para localizar el texto del cuerpo.
Firma:
bodyLocKey?: string;
AndroidNotification.channelId
El ID del canal de notificaciones de Android (nuevo en Android O). La app debe crear un canal con este ID para que se pueda recibir cualquier notificación con él. Si no envías este ID de canal en la solicitud o si la app aún no crea el ID proporcionado, FCM usa el ID de canal especificado en el manifiesto de la app.
Firma:
channelId?: string;
AndroidNotification.clickAction
La acción asociada con el clic de un usuario en la notificación. Si se especifica, se lanza una actividad con un filtro de intents que coincide cuando un usuario hace clic en la notificación.
Firma:
clickAction?: string;
AndroidNotification.color
Color del ícono de notificación en formato #rrggbb.
Firma:
color?: string;
AndroidNotification.defaultLightSettings
Si la estableces como true, usa la configuración de luz LED predeterminada del framework de Android para la notificación. Los valores predeterminados se especifican en config.xml. Si default_light_settings se configura como true y también se establece light_settings, se usa el light_settings especificado por el usuario en lugar del valor predeterminado.
Firma:
defaultLightSettings?: boolean;
AndroidNotification.defaultSound
Si la estableces como true, usa el sonido predeterminado del framework de Android para la notificación. Los valores predeterminados se especifican en config.xml.
Firma:
defaultSound?: boolean;
AndroidNotification.defaultVibrateTimings
Si la estableces como true, usa el patrón de vibración predeterminado del framework de Android para la notificación. Los valores predeterminados se especifican en config.xml. Si estableces default_vibrate_timings como true y también se establece vibrate_timings, se usa el valor predeterminado en lugar del vibrate_timings especificado por el usuario.
Firma:
defaultVibrateTimings?: boolean;
AndroidNotification.eventTimestamp
En el caso de las notificaciones que informan a los usuarios sobre eventos con una referencia de tiempo absoluta, establece la hora en que ocurrió el evento en la notificación. Las notificaciones del panel se ordenan por este momento.
Firma:
eventTimestamp?: Date;
AndroidNotification.icon
Recurso de ícono para la notificación de Android.
Firma:
icon?: string;
URL de notificación de Android
URL de la imagen que se mostrará en la notificación.
Firma:
imageUrl?: string;
AndroidNotification.lightSettings
Configuración para controlar la velocidad de intermitencia del LED de la notificación y el color si la luz LED está disponible en el dispositivo. El SO controla el tiempo total de intermitencia.
Firma:
lightSettings?: LightSettings;
AndroidNotification.localOnly
Define si esta notificación es relevante solo para el dispositivo actual o no. Algunas notificaciones se pueden compartir con otros dispositivos para mostrarlas de manera remota, como un reloj Wear OS. Se puede configurar esta sugerencia para que no se transmita esta notificación. Consulta las guías de Wear OS.
Firma:
localOnly?: boolean;
AndroidNotification.NotificationCount.
Establece la cantidad de elementos que representa esta notificación. Se puede mostrar como un recuento de insignias para los selectores que admiten insignias. Consulta NotificationBadge. Por ejemplo, esto podría ser útil si usas una sola notificación para representar varios mensajes nuevos, pero quieres que el recuento aquí representa la cantidad total de mensajes nuevos. Si es cero o no se especifica, los sistemas que admiten insignias usan el valor predeterminado, que consiste en aumentar el número que se muestra en el menú de presión prolongada cada vez que llega una notificación nueva.
Firma:
notificationCount?: number;
Prioridad de Android
Establece la prioridad relativa de esta notificación. En determinadas situaciones, las notificaciones de baja prioridad pueden ocultarse para el usuario. Ten en cuenta que esta prioridad difiere de AndroidMessagePriority. El cliente procesa esta prioridad después de que se entrega el mensaje. Por otro lado, AndroidMessagePriority es un concepto de FCM que controla cuándo se entrega el mensaje.
Firma:
priority?: ('min' | 'low' | 'default' | 'high' | 'max');
AndroidNotification.Sound
Nombre del archivo del sonido que se reproducirá cuando el dispositivo reciba la notificación.
Firma:
sound?: string;
AndroidNotification.sticky
Si la estableces como false o no la estableces, la notificación se descartará automáticamente cuando el usuario haga clic en ella, en el panel. Cuando se establece en true, la notificación persiste incluso cuando el usuario hace clic en ella.
Firma:
sticky?: boolean;
AndroidNotification.tag
Etiqueta de notificación. Es un identificador que se usa para reemplazar las notificaciones existentes en el panel lateral de notificaciones. Si no se configura, cada solicitud crea una nueva notificación.
Firma:
tag?: string;
AndroidNotification.ticker
Establece la cotización. texto, que se envía a los servicios de accesibilidad. En versiones anteriores a la API nivel 21 (Lollipop), configura el texto que se muestra en la barra de estado cuando llega la notificación por primera vez.
Firma:
ticker?: string;
AndroidNotification.title
Título de la notificación de Android. Cuando se proporciona, anula el título establecido mediante admin.messaging.Notification.
Firma:
title?: string;
AndroidNotification.titleLocArgs
Un array de claves de recursos que se usará en lugar de los especificadores de formato en titleLocKey.
Firma:
titleLocArgs?: string[];
AndroidNotification.titleLocKey.
Clave de la cadena del título en el recurso de cadenas de la app que se usa para localizar el texto del título.
Firma:
titleLocKey?: string;
AndroidNotification.vibrateTimingsMillis
Establece el patrón de vibración que se usará. Pasa una matriz de milisegundos para activar o desactivar el vibrador. El primer valor indica cuánto tiempo se debe esperar antes de activar el vibrador. El siguiente valor indica la duración que se debe mantener activada la vibración. Los valores siguientes alternan entre duración para apagar el vibrador y activarlo. Si estableces vibrate_timings y default_vibrate_timings está configurado como true, se usa el valor predeterminado en lugar del vibrate_timings especificado por el usuario.
Firma:
vibrateTimingsMillis?: number[];
AndroidNotification.visibility
Establece la visibilidad de la notificación. Debe ser private, public o secret. Si no se especifica, el valor predeterminado es private.
Firma:
visibility?: ('private' | 'public' | 'secret');