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

    string opcional

    Obsoleto desde Chrome 59

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

  • 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

    string opcional

    Obsoleto desde Chrome 59

    La máscara del ícono de la app no es visible para los usuarios de macOS 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 considerará el canal alfa de la imagen.

  • botones

    NotificationButton[] opcional

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

  • contextMessage

    string opcional

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

  • eventTime

    number opcional

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

  • iconUrl

    string opcional

    Es una URL que dirige al avatar del remitente, al ícono de la app o a una miniatura para las notificaciones con 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 que dirige a la miniatura de 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 para las notificaciones de varios elementos. Los usuarios de Mac OS X solo ven el primer elemento.

  • mensaje

    string opcional

    Es el contenido principal de la notificación.

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

  • priority

    number opcional

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

  • progreso

    number opcional

    El progreso actual varía de 0 a 100.

  • requireInteraction

    booleano opcional

    Chrome 50 y versiones posteriores browser.* desde Chrome 148

    Indica que la notificación debe permanecer visible en la pantalla hasta que el usuario la active o la descarte. La configuración predeterminada es false.

  • silencio

    booleano opcional

    Chrome 70 y versiones posteriores browser.* desde Chrome 148

    Indica que no se deben emitir sonidos ni vibraciones cuando se muestra la notificación. La configuración predeterminada es false.

  • título

    string opcional

    Es el 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

    Es el tipo de notificación que se mostrará. Es 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 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 expandedMessage y hasta dos botones.

"image"
Contiene un ícono, un título, un mensaje, un expandedMessage, 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, el progreso y hasta dos botones.

Métodos

clear()

browser.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á. Esto se devuelve con el método notifications.create.

Muestra

  • Promise<boolean>

    Chrome 116 y versiones posteriores browser.* desde Chrome 148

    Devuelve una promesa que se resuelve para indicar si existía una notificación coincidente.

create()

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

Crea y muestra una notificación.

Parámetros

  • notificationId

    string opcional

    Es el identificador de la notificación. Si no se establece 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 browser.* desde Chrome 148

    Devuelve una promesa que se resuelve con el ID de notificación (proporcionado o generado) que representa la notificación creada.

getAll()

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

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

Muestra

  • Promise<object>

    Chrome 116 y versiones posteriores browser.* desde Chrome 148

    Devuelve una promesa que se resuelve con el conjunto de notification_ids que se encuentran actualmente en el sistema.

getPermissionLevel()

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

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

Muestra

  • Promise<PermissionLevel>

    Chrome 116 y versiones posteriores browser.* desde Chrome 148

    Devuelve una promesa que se resuelve con el nivel de permiso actual.

update()

browser.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á. Esto se devuelve con el método notifications.create.

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

Muestra

  • Promise<boolean>

    Chrome 116 y versiones posteriores browser.* desde Chrome 148

    Devuelve una promesa que se resuelve para indicar si existía una notificación coincidente.

Eventos

onButtonClicked

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

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

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

La notificación se cerró, 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

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

Obsoleta desde Chrome 65
browser.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 acceder 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