chrome.management

Descripción

La API de chrome.management proporciona formas de administrar las apps y extensiones instaladas.

Permisos

management

Debes declarar el permiso "management" en el manifiesto de la extensión para usar la API de management. Por ejemplo:

{   "name": "My extension",   ...   "permissions": [     "management"   ],   ... }

management.getPermissionWarningsByManifest(), management.uninstallSelf() y management.getSelf() no requieren el permiso de administración.

Tipos

ExtensionDisabledReason

Chrome 44 y versiones posteriores

Es un motivo por el que el elemento está inhabilitado.

Enum

"unknown"

"permissions_increase"

ExtensionInfo

Es información sobre una extensión, una app o un tema instalados.

Propiedades

  • appLaunchUrl

    cadena opcional

    Es la URL de lanzamiento (solo está presente para las apps).

  • availableLaunchTypes

    LaunchType[] opcional

    Son los tipos de lanzamiento disponibles actualmente (solo están presentes para las apps).

  • descripción

    string

    Es la descripción de esta extensión, app o tema.

  • disabledReason

    ExtensionDisabledReason opcional

    Es un motivo por el que el elemento está inhabilitado.

  • habilitado

    booleano

    Indica si está habilitado o inhabilitado actualmente.

  • homepageUrl

    cadena opcional

    Es la URL de la página principal de esta extensión, app o tema.

  • hostPermissions

    string[]

    Devuelve una lista de permisos basados en el host.

  • íconos

    IconInfo[] opcional

    Es una lista de información de íconos. Ten en cuenta que esto solo refleja lo que se declaró en el manifiesto, y la imagen real en esa URL puede ser más grande o más pequeña que lo que se declaró, por lo que podrías considerar usar atributos explícitos de ancho y alto en las etiquetas img que hacen referencia a estas imágenes. Para obtener más detalles, consulta la documentación del manifiesto sobre los íconos.

  • id

    string

    Es el identificador único de la extensión.

  • installType

    ExtensionInstallType

    Indica cómo se instaló la extensión.

  • isApp

    booleano

    Obsoleto

    Usa management.ExtensionInfo.type.

    Es verdadero si se trata de una app.

  • launchType

    LaunchType opcional

    Es el tipo de lanzamiento de la app (solo está presente para las apps).

  • mayDisable

    booleano

    Indica si el usuario puede inhabilitar o desinstalar esta extensión.

  • mayEnable

    booleano opcional

    Chrome 62 y versiones posteriores

    Indica si el usuario puede habilitar esta extensión. Este valor solo se devuelve para las extensiones que no están habilitadas.

  • nombre

    string

    Es el nombre de esta extensión, app o tema.

  • offlineEnabled

    booleano

    Indica si la extensión, la app o el tema declaran que admiten el modo sin conexión.

  • optionsUrl

    string

    Es la URL de la página de opciones del elemento, si tiene una.

  • permisos

    string[]

    Devuelve una lista de permisos basados en la API.

  • shortName

    string

    Es una versión abreviada del nombre de esta extensión, app o tema.

  • Es el tipo de extensión, app o tema.

  • updateUrl

    cadena opcional

    Es la URL de actualización de esta extensión, app o tema.

  • version

    string

    Es la versión de esta extensión, app o tema.

  • versionName

    cadena opcional

    Chrome 50 y versiones posteriores

    Es el nombre de la versión de esta extensión, app o tema si el manifiesto especificó uno.

ExtensionInstallType

Chrome 44 y versiones posteriores

Indica cómo se instaló la extensión. Uno de los siguientes valores: admin: La extensión se instaló debido a una política administrativa. development: La extensión se cargó sin empaquetar en modo de desarrollador. normal: La extensión se instaló normalmente a través de un archivo .crx. sideload: La extensión se instaló con otro software en la máquina. other: La extensión se instaló por otros medios.

Enum

"admin"

"development"

"normal"

"transferencia local"

"other"

ExtensionType

Chrome 44 y versiones posteriores

Es el tipo de extensión, app o tema.

Enum

"extension"

"hosted_app"

"packaged_app"

"legacy_packaged_app"

"theme"

"login_screen_extension"

IconInfo

Es información sobre un ícono que pertenece a una extensión, una app o un tema.

Propiedades

  • tamaño

    número

    Es un número que representa el ancho y la altura del ícono. Los valores probables incluyen (sin limitaciones) 128, 48, 24 y 16.

  • url

    string

    Es la URL de la imagen de este ícono. Para mostrar una versión en escala de grises del ícono (para indicar que una extensión está inhabilitada, por ejemplo), agrega ?grayscale=true a la URL.

LaunchType

Estos son todos los tipos de lanzamiento de apps posibles.

Enum

"OPEN_AS_REGULAR_TAB"

"OPEN_AS_PINNED_TAB"

"OPEN_AS_WINDOW"

"OPEN_FULL_SCREEN"

UninstallOptions

Chrome 88 y versiones posteriores

Opciones para controlar la desinstalación de la extensión.

Propiedades

  • showConfirmDialog

    booleano opcional

    Indica si se debe mostrar un diálogo de confirmación de desinstalación al usuario. La configuración predeterminada es false para las desinstalaciones automáticas. Si una extensión desinstala otra, se ignora este parámetro y siempre se muestra el diálogo.

Métodos

createAppShortcut()

chrome.management.createAppShortcut(
  id: string,
): Promise<void>

Muestra opciones para crear accesos directos a una app. En Mac, solo se pueden crear accesos directos a apps empaquetadas.

Parámetros

Muestra

  • Promise<void>

    Chrome 88 y versiones posteriores 
chrome.management.generateAppForLink(
  url: string,
  title: string,
): Promise<ExtensionInfo>

Genera una app para una URL. Devuelve la app de marcadores generada.

Parámetros

  • url

    string

    Es la URL de una página web. El esquema de la URL solo puede ser "http" o "https".

  • título

    string

    Es el título de la app generada.

Muestra

get()

chrome.management.get(
  id: string,
): Promise<ExtensionInfo>

Devuelve información sobre la extensión, la app o el tema instalados que tienen el ID determinado.

Parámetros

Muestra

getAll()

chrome.management.getAll(): Promise<ExtensionInfo[]>

Devuelve una lista de información sobre las extensiones y las apps instaladas.

Muestra

getPermissionWarningsById()

chrome.management.getPermissionWarningsById(
  id: string,
): Promise<string[]>

Devuelve una lista de advertencias de permisos para el ID de extensión determinado.

Parámetros

  • id

    string

    Es el ID de una extensión ya instalada.

Muestra

  • Promise<string[]>

    Chrome 88 y versiones posteriores

getPermissionWarningsByManifest()

chrome.management.getPermissionWarningsByManifest(
  manifestStr: string,
): Promise<string[]>

Devuelve una lista de advertencias de permisos para la cadena de manifiesto de extensión determinada. Nota: Esta función se puede usar sin solicitar el permiso "management" en el manifiesto.

Parámetros

  • manifestStr

    string

    Es un string JSON del manifiesto de la extensión.

Muestra

  • Promise<string[]>

    Chrome 88 y versiones posteriores

getSelf()

chrome.management.getSelf(): Promise<ExtensionInfo>

Devuelve información sobre la extensión, la app o el tema que realiza la llamada. Nota: Esta función se puede usar sin solicitar el permiso "management" en el manifiesto.

Muestra

installReplacementWebApp()

Chrome 77 y versiones posteriores 
chrome.management.installReplacementWebApp(): Promise<void>

Inicia la app web de reemplazo especificada en el manifiesto. Le solicita al usuario que instale la app si aún no lo hizo.

Muestra

  • Promise<void>

    Chrome 88 y versiones posteriores

launchApp()

chrome.management.launchApp(
  id: string,
): Promise<void>

Inicia una aplicación.

Parámetros

  • id

    string

    Es el ID de extensión de la aplicación.

Muestra

  • Promise<void>

    Chrome 88 y versiones posteriores

setEnabled()

chrome.management.setEnabled(
  id: string,
  enabled: boolean,
): Promise<void>

Habilita o inhabilita una app o extensión. En la mayoría de los casos, esta función debe llamarse en el contexto de un gesto del usuario (p.ej., un controlador onclick para un botón) y puede presentar al usuario una IU de confirmación nativa como una forma de evitar abusos.

Parámetros

  • id

    string

    Debe ser el ID de un elemento de management.ExtensionInfo.

  • habilitado

    booleano

    Indica si este elemento debe habilitarse o inhabilitarse.

Muestra

  • Promise<void>

    Chrome 88 y versiones posteriores

setLaunchType()

chrome.management.setLaunchType(
  id: string,
  launchType: LaunchType,
): Promise<void>

Establece el tipo de lanzamiento de una app.

Parámetros

  • id

    string

    Debe ser el ID de un elemento de la app de management.ExtensionInfo.

  • launchType

    LaunchType

    Es el tipo de lanzamiento objetivo. Siempre verifica y asegúrate de que este tipo de lanzamiento esté en ExtensionInfo.availableLaunchTypes, ya que los tipos de lanzamiento disponibles varían en las diferentes plataformas y configuraciones.

Muestra

  • Promise<void>

    Chrome 88 y versiones posteriores

uninstall()

chrome.management.uninstall(
  id: string,
  options?: UninstallOptions,
): Promise<void>

Desinstala una app o extensión instalada actualmente. Nota: Esta función no funciona en entornos administrados cuando el usuario no tiene permiso para desinstalar la extensión o la app especificadas. Si falla la desinstalación (p.ej., el usuario cancela el diálogo), se rechazará la promesa o se llamará a la devolución de llamada con runtime.lastError establecido.

Parámetros

Muestra

  • Promise<void>

    Chrome 88 y versiones posteriores

uninstallSelf()

chrome.management.uninstallSelf(
  options?: UninstallOptions,
): Promise<void>

Desinstala la extensión de llamadas. Nota: Esta función se puede usar sin solicitar el permiso "management" en el manifiesto. Esta función no funciona en entornos administrados cuando el usuario no tiene permiso para desinstalar la extensión o la app especificada.

Parámetros

Muestra

  • Promise<void>

    Chrome 88 y versiones posteriores

Eventos

onDisabled

chrome.management.onDisabled.addListener(
  callback: function,
)

Se activa cuando se inhabilita una app o extensión.

Parámetros

  • callback

    función

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

    (info: ExtensionInfo) => void

onEnabled

chrome.management.onEnabled.addListener(
  callback: function,
)

Se activa cuando se habilita una app o extensión.

Parámetros

  • callback

    función

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

    (info: ExtensionInfo) => void

onInstalled

chrome.management.onInstalled.addListener(
  callback: function,
)

Se activa cuando se instala una app o extensión.

Parámetros

  • callback

    función

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

    (info: ExtensionInfo) => void

onUninstalled

chrome.management.onUninstalled.addListener(
  callback: function,
)

Se activa cuando se desinstala una app o extensión.

Parámetros

  • callback

    función

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

    (id: string) => void

    • id

      string