chrome.management

Descripción

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

Permisos

management

Manifiesto

Debes declarar la "administración" en el manifiesto de extensiones para usar la en la API de Cloud. 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

Un motivo por el que el elemento está inhabilitado.

Enum

“desconocido”

"permissions_increase"

ExtensionInfo

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

Propiedades

  • appLaunchUrl

    string opcional

    La URL de inicio (solo presente para apps).

  • availableLaunchTypes

    LaunchType[] opcional

    Los tipos de inicio disponibles actualmente (solo presentes para las apps).

  • descripción

    string

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

  • disabledReason

    ExtensionDisabledReason opcional

    Un motivo por el que el elemento está inhabilitado.

  • habilitado

    boolean

    Si está habilitada o inhabilitada actualmente.

  • homepageUrl

    string opcional

    La URL de la página principal de esta extensión, aplicación o tema.

  • hostPermissions

    string[]

    Muestra una lista de permisos basados en host.

  • íconos

    IconInfo[] opcional

    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 la declarada, por lo que puedes considerar el uso de atributos explícitos de ancho y alto en etiquetas img que hagan referencia a estas imágenes. Para obtener más información, consulta la documentación sobre manifiestos sobre íconos.

  • id

    string

    El identificador único de la extensión.

  • installType

    ExtensionInstallType

    La forma en que se instaló la extensión.

  • isApp

    boolean

    Obsoleto

    Usa management.ExtensionInfo.type.

    Es verdadero si se trata de una app.

  • launchType

    LaunchType opcional

    Es el tipo de inicio de la app (solo presente para las apps).

  • mayDisable

    boolean

    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. Esto solo se muestra para las extensiones que no están habilitadas.

  • nombre

    string

    El nombre de esta extensión, app o tema.

  • offlineEnabled

    boolean

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

  • optionsUrl

    string

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

  • permisos

    string[]

    Muestra una lista de permisos basados en API.

  • NombreCorto

    string

    Una versión breve del nombre de esta extensión, app o tema.

  • El tipo de extensión, app o tema.

  • updateUrl

    string opcional

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

  • versión

    string

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

  • versionName

    string opcional

    Chrome 50 y versiones posteriores

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

ExtensionInstallType

Chrome 44 y versiones posteriores

La forma en que se instaló la extensión. Uno de 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: Otro software instaló la extensión en la máquina. other: La extensión se instaló por otros medios.

Enum

“administrador”

“desarrollo”

“normal”

“transferencia”

“otro”

ExtensionType

Chrome 44 y versiones posteriores

El tipo de extensión, app o tema.

Enum

“extensión”

"host_app"

"packaged_app"

"legacy_packaged_app"

“tema”

"login_screen_extension"

IconInfo

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 (entre otros) 128, 48, 24 y 16.

  • url

    string

    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

Todos estos son posibles tipos de lanzamiento de apps.

Enum

"OPEN_AS_REGULAR_TAB"

"OPEN_AS_PINNED_TAB"

"OPEN_AS_WINDOW"

"OPEN_FULL_SCREEN"

UninstallOptions

Chrome 88 y versiones posteriores

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

Propiedades

  • showConfirmDialog

    booleano opcional

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

Métodos

createAppShortcut()

Promesa 
chrome.management.createAppShortcut(
  id: string,
  callback?: function,
)

Muestra opciones para crear combinaciones de teclas para una app. En Mac, solo se pueden crear accesos directos de aplicaciones empaquetadas.

Parámetros

  • id

    string

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

  • callback

    función opcional

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

    () => void

Muestra

  • Promesa<void>

    Chrome 88 y versiones posteriores

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

Promesa 
chrome.management.generateAppForLink(
  url: string,
  title: string,
  callback?: function,
)

Genera una app para una URL. Muestra la app de favoritos generada.

Parámetros

  • url

    string

    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.

  • callback

    función opcional

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

    (result: ExtensionInfo) => void

Muestra

  • Promise&lt;ExtensionInfo&gt;

    Chrome 88 y versiones posteriores

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

get()

Promesa 
chrome.management.get(
  id: string,
  callback?: function,
)

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

Parámetros

Muestra

  • Promise&lt;ExtensionInfo&gt;

    Chrome 88 y versiones posteriores

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

getAll()

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

Muestra una lista de información sobre las extensiones y aplicaciones instaladas.

Parámetros

  • callback

    función opcional

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

    (result: ExtensionInfo[]) => void

Muestra

  • Promise&lt;ExtensionInfo[]&gt;

    Chrome 88 y versiones posteriores

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

getPermissionWarningsById()

Promesa 
chrome.management.getPermissionWarningsById(
  id: string,
  callback?: function,
)

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

Parámetros

  • id

    string

    El ID de una extensión ya instalada.

  • callback

    función opcional

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

    (permissionWarnings: string[]) => void

    • permissionWarnings

      string[]

Muestra

  • Promise&lt;string[]&gt;

    Chrome 88 y versiones posteriores

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

getPermissionWarningsByManifest()

Promesa 
chrome.management.getPermissionWarningsByManifest(
  manifestStr: string,
  callback?: function,
)

Muestra una lista de advertencias de permisos para la string del manifiesto de la extensión especificada. Nota: Esta función se puede usar sin solicitar la "administración" permiso en el manifiesto.

Parámetros

  • manifestStr

    string

    String JSON del manifiesto de la extensión.

  • callback

    función opcional

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

    (permissionWarnings: string[]) => void

    • permissionWarnings

      string[]

Muestra

  • Promise&lt;string[]&gt;

    Chrome 88 y versiones posteriores

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

getSelf()

Promesa 
chrome.management.getSelf(
  callback?: function,
)

Muestra información sobre la extensión, la app o el tema de llamada. Nota: Esta función se puede usar sin solicitar la "administración" permiso en el manifiesto.

Parámetros

  • callback

    función opcional

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

    (result: ExtensionInfo) => void

Muestra

  • Promise&lt;ExtensionInfo&gt;

    Chrome 88 y versiones posteriores

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

installReplacementWebApp()

Promesa Chrome 77 y versiones posteriores .
chrome.management.installReplacementWebApp(
  callback?: function,
)

Inicia la replace_web_app especificada en el manifiesto. Le pide al usuario que instale si aún no lo hizo.

Parámetros

  • callback

    función opcional

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

    () => void

Muestra

  • Promesa<void>

    Chrome 88 y versiones posteriores

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

launchApp()

Promesa 
chrome.management.launchApp(
  id: string,
  callback?: function,
)

Inicia una aplicación.

Parámetros

  • id

    string

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

  • callback

    función opcional

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

    () => void

Muestra

  • Promesa<void>

    Chrome 88 y versiones posteriores

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

setEnabled()

Promesa 
chrome.management.setEnabled(
  id: string,
  enabled: boolean,
  callback?: function,
)

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

Parámetros

  • id

    string

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

  • habilitado

    boolean

    Si se debe habilitar o inhabilitar este elemento.

  • callback

    función opcional

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

    () => void

Muestra

  • Promesa<void>

    Chrome 88 y versiones posteriores

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

setLaunchType()

Promesa 
chrome.management.setLaunchType(
  id: string,
  launchType: LaunchType,
  callback?: function,
)

Configura el tipo de inicio de una app.

Parámetros

  • id

    string

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

  • launchType

    LaunchType

    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 según la plataforma y la configuración.

  • callback

    función opcional

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

    () => void

Muestra

  • Promesa<void>

    Chrome 88 y versiones posteriores

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

uninstall()

Promesa 
chrome.management.uninstall(
  id: string,
  options?: UninstallOptions,
  callback?: function,
)

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

Parámetros

  • id

    string

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

  • opciones

    UninstallOptions (opcional)

  • callback

    función opcional

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

    () => void

Muestra

  • Promesa<void>

    Chrome 88 y versiones posteriores

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

uninstallSelf()

Promesa 
chrome.management.uninstallSelf(
  options?: UninstallOptions,
  callback?: function,
)

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

Parámetros

  • opciones

    UninstallOptions (opcional)

  • callback

    función opcional

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

    () => void

Muestra

  • Promesa<void>

    Chrome 88 y versiones posteriores

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

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