Representa las opciones de notificación específicas de Android que se pueden incluir en AndroidConfig .
Firma:
export interface AndroidNotification
Propiedades
Propiedad | Escribe | Descripción |
---|---|---|
cuerpo | cuerda | Cuerpo de la notificación de Android. Cuando se proporciona, anula el cuerpo establecido a través admin.messaging.Notification . |
cuerpoLocArgs | cuerda[] | Una matriz de claves de recursos que se usarán en lugar de los especificadores de formato en bodyLocKey . |
bodyLocKey | cuerda | Clave de la cadena del cuerpo en el recurso de cadena de la aplicación que se usará para localizar el texto del cuerpo. |
Canal ID | cuerda | El ID del canal de notificación de Android (nuevo en Android O). La aplicación debe crear un canal con este ID de canal antes de que se pueda recibir cualquier notificación con este ID de canal. Si no envía este ID de canal en la solicitud, o si la aplicación aún no ha creado el ID de canal proporcionado, FCM usa el ID de canal especificado en el manifiesto de la aplicación. |
hacer clic en Acción | cuerda | Acción asociada a un clic de usuario en la notificación. Si se especifica, se inicia una actividad con un filtro de intención coincidente cuando un usuario hace clic en la notificación. |
color | cuerda | Color del icono de notificación en formato #rrggbb . |
configuración de luz predeterminada | booleano | Si se establece en true , use la configuración de luz LED predeterminada del marco de trabajo de Android para la notificación. Los valores predeterminados se especifican en config.xml . Si default_light_settings se establece en true y light_settings también se establece, se utiliza la configuración de light_settings especificada por el usuario en lugar del valor predeterminado. |
sonido por defecto | booleano | Si se establece en true , use el sonido predeterminado del marco de trabajo de Android para la notificación. Los valores predeterminados se especifican en config.xml . |
por defectoVibrarTiempos | booleano | Si se establece en true , use el patrón de vibración predeterminado del marco de trabajo de Android para la notificación. Los valores predeterminados se especifican en config.xml . Si default_vibrate_timings se establece en true y vibrate_timings también se establece, se usa el valor predeterminado en lugar de vibrate_timings especificado por el usuario. |
eventTimestamp | Fecha | Para las notificaciones que informan a los usuarios sobre eventos con una referencia de tiempo absoluto, establece la hora en que ocurrió el evento en la notificación. Las notificaciones en el panel se ordenan por hora. |
icono | cuerda | Recurso de iconos para la notificación de Android. |
URL de la imagen | cuerda | URL de una imagen que se mostrará en la notificación. |
ajustes de luz | Ajustes de luz | Configuraciones para controlar la velocidad de parpadeo del LED de la notificación y el color si el LED está disponible en el dispositivo. El tiempo total de parpadeo está controlado por el sistema operativo. |
solo locales | booleano | Establece si esta notificación es relevante o no solo para el dispositivo actual. Algunas notificaciones se pueden vincular a otros dispositivos para visualización remota, como un reloj Wear OS. Esta sugerencia se puede configurar para recomendar que esta notificación no se puentee. Consulte las guías de Wear OS . |
notificaciónCount | número | Establece el número de elementos que representa esta notificación. Puede mostrarse como un recuento de insignias para los Lanzadores que admiten insignias. Ver Insignia de Notificación . Por ejemplo, esto podría ser útil si usa solo una notificación para representar varios mensajes nuevos, pero desea que el recuento aquí represente la cantidad total de mensajes nuevos. Si es cero o no se especifica, los sistemas que admiten la credencialización usan el valor predeterminado, que consiste en incrementar un número que se muestra en el menú de pulsación prolongada cada vez que llega una nueva notificación. |
prioridad | ('mínimo' | 'bajo' | 'predeterminado' | 'alto' | 'máximo') | Establece la prioridad relativa para esta notificación. Las notificaciones de baja prioridad pueden estar ocultas para el usuario en ciertas situaciones. Tenga en cuenta que esta prioridad difiere de AndroidMessagePriority . Esta prioridad es procesada por el cliente después de que se haya entregado el mensaje. Mientras que AndroidMessagePriority es un concepto de FCM que controla cuándo se entrega el mensaje. |
sonido | cuerda | Nombre de archivo del sonido que se reproducirá cuando el dispositivo reciba la notificación. |
pegajoso | booleano | Cuando se establece en false o no se establece, la notificación se descarta automáticamente cuando el usuario hace clic en ella en el panel. Cuando se establece en true , la notificación persiste incluso cuando el usuario hace clic en ella. |
etiqueta | cuerda | Etiqueta de notificación. Este es un identificador que se utiliza para reemplazar las notificaciones existentes en el cajón de notificaciones. Si no se especifica, cada solicitud crea una nueva notificación. |
corazón | cuerda | Establece el texto del "ticker", que se envía a los servicios de accesibilidad. Antes del nivel de API 21 (Lollipop), establece el texto que se muestra en la barra de estado cuando llega la notificación por primera vez. |
título | cuerda | Título de la notificación de Android. Cuando se proporciona, anula el título establecido a través admin.messaging.Notification . |
titleLocArgs | cuerda[] | Una matriz de claves de recursos que se usarán en lugar de los especificadores de formato en titleLocKey . |
titleLocKey | cuerda | Clave de la cadena de título en el recurso de cadena de la aplicación que se usará para localizar el texto del título. |
vibrarTiemposMillis | número[] | Establece el patrón de vibración a utilizar. Pase una serie de milisegundos para encender o apagar el vibrador. El primer valor indica el tiempo de espera antes de encender el vibrador. El siguiente valor indica la duración para mantener el vibrador encendido. Los valores subsiguientes alternan entre la duración para apagar y encender el vibrador. Si se establece vibrate_timings y default_vibrate_timings se establece en true , se usa el valor predeterminado en lugar de 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, el valor predeterminado es private . |
AndroidNotification.cuerpo
Cuerpo de la notificación de Android. Cuando se proporciona, anula el cuerpo establecido a través admin.messaging.Notification
.
Firma:
body?: string;
AndroidNotification.bodyLocArgs
Una matriz de claves de recursos que se usarán en lugar de los especificadores de formato en bodyLocKey
.
Firma:
bodyLocArgs?: string[];
AndroidNotification.bodyLocKey
Clave de la cadena del cuerpo en el recurso de cadena de la aplicación que se usará para localizar el texto del cuerpo.
Firma:
bodyLocKey?: string;
AndroidNotification.channelId
El ID del canal de notificación de Android (nuevo en Android O). La aplicación debe crear un canal con este ID de canal antes de que se pueda recibir cualquier notificación con este ID de canal. Si no envía este ID de canal en la solicitud, o si la aplicación aún no ha creado el ID de canal proporcionado, FCM usa el ID de canal especificado en el manifiesto de la aplicación.
Firma:
channelId?: string;
AndroidNotification.clickAcción
Acción asociada a un clic de usuario en la notificación. Si se especifica, se inicia una actividad con un filtro de intención coincidente cuando un usuario hace clic en la notificación.
Firma:
clickAction?: string;
Notificación de Android.color
Color del icono de notificación en formato #rrggbb
.
Firma:
color?: string;
AndroidNotification.defaultLightSettings
Si se establece en true
, use la configuración de luz LED predeterminada del marco de trabajo de Android para la notificación. Los valores predeterminados se especifican en config.xml . Si default_light_settings
se establece en true
y light_settings
también se establece, se utiliza la configuración de light_settings
especificada por el usuario en lugar del valor predeterminado.
Firma:
defaultLightSettings?: boolean;
AndroidNotification.defaultSound
Si se establece en true
, use el sonido predeterminado del marco de trabajo de Android para la notificación. Los valores predeterminados se especifican en config.xml .
Firma:
defaultSound?: boolean;
AndroidNotification.defaultVibrateTimings
Si se establece en true
, use el patrón de vibración predeterminado del marco de trabajo de Android para la notificación. Los valores predeterminados se especifican en config.xml . Si default_vibrate_timings
se establece en true
y vibrate_timings
también se establece, se utiliza el valor predeterminado en lugar de vibrate_timings
especificado por el usuario .
Firma:
defaultVibrateTimings?: boolean;
AndroidNotification.eventTimestamp
Para las notificaciones que informan a los usuarios sobre eventos con una referencia de tiempo absoluto, establece la hora en que ocurrió el evento en la notificación. Las notificaciones en el panel se ordenan por hora.
Firma:
eventTimestamp?: Date;
AndroidNotification.icon
Recurso de iconos para la notificación de Android.
Firma:
icon?: string;
AndroidNotification.imageUrl
URL de una imagen que se mostrará en la notificación.
Firma:
imageUrl?: string;
AndroidNotification.lightSettings
Configuraciones para controlar la velocidad de parpadeo del LED de la notificación y el color si el LED está disponible en el dispositivo. El tiempo total de parpadeo está controlado por el sistema operativo.
Firma:
lightSettings?: LightSettings;
AndroidNotification.localOnly
Establece si esta notificación es relevante o no solo para el dispositivo actual. Algunas notificaciones se pueden vincular a otros dispositivos para visualización remota, como un reloj Wear OS. Esta sugerencia se puede configurar para recomendar que esta notificación no se puentee. Consulte las guías de Wear OS .
Firma:
localOnly?: boolean;
AndroidNotification.notificationCount
Establece el número de elementos que representa esta notificación. Puede mostrarse como un recuento de insignias para los Lanzadores que admiten insignias. Ver Insignia de Notificación . Por ejemplo, esto podría ser útil si usa solo una notificación para representar varios mensajes nuevos, pero desea que el recuento aquí represente la cantidad total de mensajes nuevos. Si es cero o no se especifica, los sistemas que admiten la credencialización usan el valor predeterminado, que consiste en incrementar un número que se muestra en el menú de pulsación prolongada cada vez que llega una nueva notificación.
Firma:
notificationCount?: number;
AndroidNotification.priority
Establece la prioridad relativa para esta notificación. Las notificaciones de baja prioridad pueden estar ocultas para el usuario en ciertas situaciones. Tenga en cuenta que esta prioridad difiere de AndroidMessagePriority
. Esta prioridad es procesada por el cliente después de que se haya entregado el mensaje. Mientras que AndroidMessagePriority
es un concepto de FCM que controla cuándo se entrega el mensaje.
Firma:
priority?: ('min' | 'low' | 'default' | 'high' | 'max');
AndroidNotificación.sonido
Nombre de archivo del sonido que se reproducirá cuando el dispositivo reciba la notificación.
Firma:
sound?: string;
AndroidNotification.sticky
Cuando se establece en false
o no se establece, la notificación se descarta automáticamente cuando el usuario hace 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. Este es un identificador que se utiliza para reemplazar las notificaciones existentes en el cajón de notificaciones. Si no se especifica, cada solicitud crea una nueva notificación.
Firma:
tag?: string;
Notificación de Android.ticker
Establece el texto del "ticker", que se envía a los servicios de accesibilidad. Antes del nivel de API 21 (Lollipop), establece el texto que se muestra en la barra de estado cuando llega la notificación por primera vez.
Firma:
ticker?: string;
AndroidNotification.título
Título de la notificación de Android. Cuando se proporciona, anula el título establecido a través admin.messaging.Notification
.
Firma:
title?: string;
AndroidNotification.titleLocArgs
Una matriz de claves de recursos que se usarán en lugar de los especificadores de formato en titleLocKey
.
Firma:
titleLocArgs?: string[];
AndroidNotification.titleLocKey
Clave de la cadena de título en el recurso de cadena de la aplicación que se usará para localizar el texto del título.
Firma:
titleLocKey?: string;
AndroidNotification.vibrateTimingsMillis
Establece el patrón de vibración a utilizar. Pase una serie de milisegundos para encender o apagar el vibrador. El primer valor indica el tiempo de espera antes de encender el vibrador. El siguiente valor indica la duración para mantener el vibrador encendido. Los valores subsiguientes alternan entre la duración para apagar y encender el vibrador. Si se establece vibrate_timings
y default_vibrate_timings
se establece en true
, se utiliza el valor predeterminado en lugar de vibrate_timings
especificado por el usuario .
Firma:
vibrateTimingsMillis?: number[];
Notificación de Android.visibilidad
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');