chrome.notifications

Descripción

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

Permisos

notifications

Tipos

NotificationBitmap

NotificationButton

Propiedades

  • iconUrl

    cadena opcional

    Obsoleta a partir de Chrome 59

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

  • title

    cadena

NotificationItem

Propiedades

  • message

    cadena

    Detalles adicionales sobre este elemento.

  • title

    cadena

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

NotificationOptions

Propiedades

  • appIconMaskUrl

    cadena opcional

    Obsoleta a partir de 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 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 considerará el canal alfa de la imagen.

  • botones

    NotificationButton[] opcional

    Íconos y texto para hasta dos botones de acción de notificaciones.

  • contextMessage

    cadena opcional

    Alterna contenido de notificaciones con una fuente más baja.

  • eventTime

    número opcional

    Es una marca de tiempo asociada con la notificación, en milisegundos después de la época (p.ej., Date.now() + n).

  • iconUrl

    cadena opcional

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

    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

    cadena opcional

    Obsoleta a partir de Chrome 59

    Los usuarios de Mac OS X no pueden ver la imagen.

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

  • isClickable

    booleano opcional

    Obsoleta a partir de Chrome 67

    A partir de Chrome 67, se ignora esta sugerencia de la IU

  • items

    NotificationItem[] opcional

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

  • message

    cadena opcional

    Contenido de notificación principal.

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

  • priority

    número opcional

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

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

  • title

    cadena opcional

    Título de la notificación (p. ej., 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 optó por no mostrar notificaciones de la app o extensión.

TemplateType

Enum

“básica”
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, título, mensaje, progreso y hasta dos botones.

Métodos

clear()

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

Borra la notificación especificada.

Parámetros

  • notificationId

    cadena

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

  • callback

    Función opcional

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

    (wasCleared: boolean)=>void

    • wasCleared

      boolean

Devuelve

  • Promise<boolean>

    Chrome 116 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

create()

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

Crea y muestra una notificación.

Parámetros

  • notificationId

    cadena opcional

    Es el identificador de la notificación. Si no la estableces o la estableces, se generará automáticamente un ID. 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.

    Para las versiones anteriores a Chrome 42, se requiere el parámetro notificationId.

  • Contenido de la notificación.

  • callback

    Función opcional

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

    (notificationId: string)=>void

    • notificationId

      cadena

Devuelve

  • Promesa<string>

    Chrome 116 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución 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

Devuelve

  • Promise<object>

    Chrome 116 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

getPermissionLevel()

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

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

Parámetros

Devuelve

  • Promise<PermissionLevel>

    Chrome 116 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

update()

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

Actualiza una notificación existente.

Parámetros

  • notificationId

    cadena

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

  • Contenido de la notificación a actualizar.

  • callback

    Función opcional

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

    (wasUpdated: boolean)=>void

    • wasUpdated

      boolean

Devuelve

  • Promise<boolean>

    Chrome 116 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

Eventos

onButtonClicked

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

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

Parámetros

  • callback

    la función

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

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

    • notificationId

      cadena

    • 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

    la función

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

    (notificationId: string)=>void

    • notificationId

      cadena

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

    la función

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

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

    • notificationId

      cadena

    • 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 despacha este evento.

Parámetros

onShowSettings

Obsoleta a partir de 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 para ver la configuración de notificaciones de la app. A partir de Chrome 47, solo ChromeOS tiene una IU que despacha este evento. A partir de Chrome 65, esa IU también se quitó de ChromeOS.

Parámetros

  • callback

    la función

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

    ()=>void