chrome.notifications

Descripción

Usa la API de chrome.notifications para crear notificaciones enriquecidas con plantillas y mostrarlas a los usuarios en la bandeja del sistema.

Permisos

notifications

Tipos

NotificationBitmap

NotificationButton

Propiedades

  • iconUrl

    cadena opcional

    Obsoleto desde Chrome 59

    Los usuarios de Mac OS X no pueden ver los íconos de los botones.

  • título

    string

NotificationItem

Propiedades

  • mensaje

    string

    Son los detalles adicionales sobre este elemento.

  • título

    string

    Es el título de un elemento de una notificación de lista.

NotificationOptions

Propiedades

  • appIconMaskUrl

    cadena opcional

    Obsoleto desde Chrome 59

    La máscara del ícono de la app no es visible para los usuarios de Mac OS X.

    Es una URL a la máscara del ícono de la app. Las URLs tienen las mismas restricciones que iconUrl.

    La máscara del ícono de la app debe estar en el canal alfa, ya que solo se tendrá en cuenta el canal alfa de la imagen.

  • botones

    NotificationButton[] opcional

    Texto e íconos para hasta dos botones de acción de notificación.

  • contextMessage

    cadena opcional

    Contenido de notificación alternativo con una fuente de menor peso.

  • eventTime

    número opcional

    Es una marca de tiempo asociada a la notificación, en milisegundos transcurridos desde la época (p.ej., Date.now() + n).

  • iconUrl

    cadena opcional

    Es una URL que dirige al avatar del remitente, al ícono de la app o a una miniatura para las notificaciones de imágenes.

    Las URLs pueden ser URLs de datos, URLs de BLOB o URLs relativas a un recurso dentro del archivo .crx de esta extensión.

    **Nota:**Este valor es obligatorio para el método notifications.create().

  • imageUrl

    cadena opcional

    Obsoleto desde Chrome 59

    La imagen no es visible para los usuarios de Mac OS X.

    Es una URL a la miniatura de la imagen para las notificaciones de tipo imagen. Las URLs tienen las mismas restricciones que iconUrl.

  • isClickable

    booleano opcional

    Obsoleto desde Chrome 67

    Esta sugerencia de IU se ignora a partir de Chrome 67

  • elementos

    NotificationItem[] opcional

    Son los elementos de las notificaciones de varios elementos. Los usuarios de Mac OS X solo ven el primer elemento.

  • mensaje

    cadena opcional

    Es el contenido principal de la notificación.

    **Nota:**Este valor es obligatorio para el método notifications.create().

  • priority

    número opcional

    La prioridad varía de -2 a 2. El valor -2 es la prioridad más baja. El 2 es el más alto. El valor predeterminado es cero. En las plataformas que no admiten un centro de notificaciones (Windows, Linux y Mac), los valores -2 y -1 generan un error, ya que las notificaciones con esas prioridades no se mostrarán.

  • progreso

    número opcional

    El progreso actual varía de 0 a 100.

  • requireInteraction

    booleano opcional

    Chrome 50 y versiones posteriores

    Indica que la notificación debe permanecer visible en la pantalla hasta que el usuario la active o la descarte. El valor predeterminado es falso.

  • silencio

    booleano opcional

    Chrome 70 y versiones posteriores

    Indica que no se deben emitir sonidos ni vibraciones cuando se muestre la notificación. El valor predeterminado es falso.

  • título

    cadena opcional

    Título de la notificación (p.ej., nombre del remitente en el caso de un correo electrónico).

    **Nota:**Este valor es obligatorio para el método notifications.create().

  • tipo

    TemplateType opcional

    Es el tipo de notificación que se mostrará. Obligatorio para el método notifications.create

PermissionLevel

Enum

"granted"
Especifica que el usuario eligió mostrar notificaciones de la app o extensión. Este es el valor predeterminado durante la instalación.

"denied"
Especifica que el usuario eligió no mostrar notificaciones de la app o extensión.

TemplateType

Enum

"basic"
Contiene un ícono, un título, un mensaje, un mensaje expandido y hasta dos botones.

"image"
Contiene un ícono, un título, un mensaje, un mensaje expandido, una imagen y hasta dos botones.

"list"
Contiene un ícono, un título, un mensaje, elementos y hasta dos botones. Los usuarios de Mac OS X solo ven el primer elemento.

"progress"
Contiene un ícono, un título, un mensaje, un progreso y hasta dos botones.

Métodos

clear()

chrome.notifications.clear(
  notificationId: string,
): Promise<boolean>

Borra la notificación especificada.

Parámetros

  • notificationId

    string

    Es el ID de la notificación que se borrará. El método notifications.create devuelve este valor.

Muestra

  • Promise<boolean>

    Chrome 116 y versiones posteriores

create()

chrome.notifications.create(
  notificationId?: string,
  options: NotificationOptions,
): Promise<string>

Crea y muestra una notificación.

Parámetros

  • notificationId

    cadena opcional

    Es el identificador de la notificación. Si no se configura o está vacío, se generará un ID automáticamente. Si coincide con una notificación existente, este método primero borra esa notificación antes de continuar con la operación de creación. El identificador no puede tener más de 500 caracteres.

    El parámetro notificationId es obligatorio antes de Chrome 42.

  • Es el contenido de la notificación.

Muestra

  • Promise<string>

    Chrome 116 y versiones posteriores

getAll()

chrome.notifications.getAll(): Promise<object>

Recupera todas las notificaciones de esta app o extensión.

Muestra

  • Promise<object>

    Chrome 116 y versiones posteriores

getPermissionLevel()

chrome.notifications.getPermissionLevel(): Promise<PermissionLevel>

Recupera si el usuario habilitó las notificaciones de esta app o extensión.

Muestra

update()

chrome.notifications.update(
  notificationId: string,
  options: NotificationOptions,
): Promise<boolean>

Actualiza una notificación existente.

Parámetros

  • notificationId

    string

    Es el ID de la notificación que se actualizará. El método notifications.create devuelve este valor.

  • Es el contenido de la notificación que se actualizará.

Muestra

  • Promise<boolean>

    Chrome 116 y versiones posteriores

Eventos

onButtonClicked

chrome.notifications.onButtonClicked.addListener(
  callback: function,
)

El usuario presionó un botón en la notificación.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (notificationId: string, buttonIndex: number) => void

    • notificationId

      string

    • buttonIndex

      número

onClicked

chrome.notifications.onClicked.addListener(
  callback: function,
)

El usuario hizo clic en un área de la notificación que no es un botón.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (notificationId: string) => void

    • notificationId

      string

onClosed

chrome.notifications.onClosed.addListener(
  callback: function,
)

Se cerró la notificación, ya sea por el sistema o por una acción del usuario.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (notificationId: string, byUser: boolean) => void

    • notificationId

      string

    • byUser

      booleano

onPermissionLevelChanged

chrome.notifications.onPermissionLevelChanged.addListener(
  callback: function,
)

El usuario cambia el nivel de permiso. A partir de Chrome 47, solo ChromeOS tiene una IU que envía este evento.

Parámetros

onShowSettings

Obsoleto desde Chrome 65
chrome.notifications.onShowSettings.addListener(
  callback: function,
)

Ya no se admite el botón de configuración de notificaciones personalizadas.

El usuario hizo clic en un vínculo a la configuración de notificaciones de la app. A partir de Chrome 47, solo ChromeOS tiene una IU que envía este evento. A partir de Chrome 65, esa IU también se quitó de ChromeOS.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    () => void