chrome.notifications

Descripción

Usa la API de chrome.notifications para crear notificaciones enriquecidas mediante plantillas y muéstralas a los usuarios en la bandeja del sistema.

Permisos

notifications

Tipos

NotificationBitmap

NotificationButton

Propiedades

  • iconUrl

    string opcional

    Obsoleto desde Chrome 59

    Los íconos de botones no son visibles para los usuarios de Mac OS X.

  • título

    string

NotificationItem

Propiedades

  • mensaje

    string

    Detalles adicionales sobre este elemento.

  • título

    string

    Título de un elemento de una notificación de lista.

NotificationOptions

Propiedades

  • appIconMaskUrl

    string opcional

    Obsoleto desde Chrome 59

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

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

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

  • botones

    NotificationButton[] opcional

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

  • contextMessage

    string opcional

    Contenido de notificaciones alternativo con una fuente de menor grosor.

  • eventTime

    número opcional

    Una marca de tiempo asociada con la notificación, en milisegundos transcurridos el ciclo de entrenamiento (p.ej., Date.now() + n).

  • iconUrl

    string opcional

    Una URL al avatar del remitente, el ícono de la app o una miniatura para las notificaciones de imágenes.

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

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

  • imageUrl

    string 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 notificaciones de tipo de imagen. Las URL 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

    Elementos para notificaciones de varios elementos. Los usuarios de Mac OS X solo ven el primer elemento.

  • mensaje

    string opcional

    Contenido principal de la notificación.

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

  • priority

    número opcional

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

  • progreso

    número opcional

    El progreso actual oscila entre 0 y 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 muestra la notificación. El valor predeterminado es falso.

  • título

    string opcional

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

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

  • tipo

    TemplateType opcional

    Qué tipo de notificación mostrar Obligatorio para el método notifications.create.

PermissionLevel

Enum

"granted"
Especifica que el usuario eligió mostrar notificaciones de la app o extensión. Esta es la configuración predeterminada en el momento de 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()

Promesa 
chrome.notifications.clear(
  notificationId: string,
  callback?: function,
)

Borra la notificación especificada.

Parámetros

  • notificationId

    string

    El ID de la notificación que se borrará. El método notifications.create lo muestra.

  • callback

    función opcional

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

    (wasCleared: boolean) => void

    • wasCleared

      boolean

Muestra

  • Promise<boolean>

    Chrome 116 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

create()

Promesa 
chrome.notifications.create(
  notificationId?: string,
  options: NotificationOptions,
  callback?: function,
)

Crea y muestra una notificación.

Parámetros

  • notificationId

    string opcional

    Es el identificador de la notificación. Si no se establece o se deja 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 superar los 500 caracteres.

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

  • Contenido de la notificación.

  • callback

    función opcional

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

    (notificationId: string) => void

    • notificationId

      string

Muestra

  • Promesa<string>

    Chrome 116 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

getAll()

Promesa 
chrome.notifications.getAll(
  callback?: function,
)

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

Parámetros

  • callback

    función opcional

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

    (notifications: object) => void

    • notificaciones

      objeto

Muestra

  • Promise&lt;object&gt;

    Chrome 116 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

getPermissionLevel()

Promesa 
chrome.notifications.getPermissionLevel(
  callback?: function,
)

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

Parámetros

Muestra

  • Promise&lt;PermissionLevel&gt;

    Chrome 116 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

update()

Promesa 
chrome.notifications.update(
  notificationId: string,
  options: NotificationOptions,
  callback?: function,
)

Actualiza una notificación existente.

Parámetros

  • notificationId

    string

    El ID de la notificación que se actualizará. El método notifications.create lo muestra.

  • Contenido de la notificación que se actualizará

  • callback

    función opcional

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

    (wasUpdated: boolean) => void

    • wasUpdated

      boolean

Muestra

  • Promise&lt;boolean&gt;

    Chrome 116 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

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 sin 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 la 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

      boolean

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 personalizada.

El usuario hizo clic en un vínculo para 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