browser.management

Descrição

A API chrome.management oferece maneiras de gerenciar apps e extensões instalados.

Permissões

management

É necessário declarar a permissão "management" no manifesto da extensão para usar a API Management. Exemplo:

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

management.getPermissionWarningsByManifest(), management.uninstallSelf() e management.getSelf() não exigem a permissão de gerenciamento.

Tipos

ExtensionDisabledReason

Chrome 44+ browser.* desde o Chrome 148

O motivo pelo qual o item está desativado.

Enumeração

"unknown"

"permissions_increase"

ExtensionInfo

Informações sobre uma extensão, um app ou um tema instalado.

Propriedades

  • appLaunchUrl

    string opcional

    O URL de inicialização (presente apenas para apps).

  • availableLaunchTypes

    LaunchType[] opcional

    Os tipos de lançamento disponíveis no momento (presentes apenas para apps).

  • descrição

    string

    A descrição da extensão, do app ou do tema.

  • disabledReason

    ExtensionDisabledReason opcional

    O motivo pelo qual o item está desativado.

  • ativado

    booleano

    Se está ativado ou desativado no momento.

  • homepageUrl

    string opcional

    O URL da página inicial da extensão, do app ou do tema.

  • hostPermissions

    string[]

    Retorna uma lista de permissões baseadas em host.

  • ícones

    IconInfo[] opcional

    Uma lista de informações de ícones. Isso reflete apenas o que foi declarado no manifesto, e a imagem real nesse URL pode ser maior ou menor do que o declarado. Portanto, considere usar atributos explícitos de largura e altura nas tags img que fazem referência a essas imagens. Consulte a documentação do manifesto sobre ícones para mais detalhes.

  • ID

    string

    O identificador exclusivo da extensão.

  • installType

    ExtensionInstallType

    Como a extensão foi instalada.

  • isApp

    booleano

    Descontinuado

    Use management.ExtensionInfo.type.

    Verdadeiro se for um app.

  • launchType

    LaunchType opcional

    O tipo de inicialização do app (presente apenas para apps).

  • mayDisable

    booleano

    Se essa extensão pode ser desativada ou desinstalada pelo usuário.

  • mayEnable

    booleano opcional

    Chrome 62+ browser.* desde o Chrome 148

    Indica se essa extensão pode ser ativada pelo usuário. Isso só é retornado para extensões que não estão ativadas.

  • nome

    string

    O nome da extensão, do app ou do tema.

  • offlineEnabled

    booleano

    Se a extensão, o app ou o tema declara que é compatível com o modo off-line.

  • optionsUrl

    string

    O URL da página de opções do item, se houver.

  • permissões

    string[]

    Retorna uma lista de permissões baseadas em API.

  • shortName

    string

    Uma versão curta do nome da extensão, do app ou do tema.

  • O tipo da extensão, do app ou do tema.

  • updateUrl

    string opcional

    O URL de atualização dessa extensão, app ou tema.

  • versão

    string

    A versão da extensão, do app ou do tema.

  • versionName

    string opcional

    Chrome 50+ browser.* desde o Chrome 148

    O nome da versão da extensão, do app ou do tema, se o manifesto tiver especificado um.

ExtensionInstallType

Chrome 44+ browser.* desde o Chrome 148

Como a extensão foi instalada. Um dos seguintes: admin: a extensão foi instalada devido a uma política administrativa. development: a extensão foi carregada descompactada no modo de desenvolvedor. normal: a extensão foi instalada normalmente por um arquivo .crx. sideload: a extensão foi instalada por outro software na máquina. other: a extensão foi instalada por outros meios.

Enumeração

"admin"

"development"

"normal"

"sideload"

"other"

ExtensionType

Chrome 44+ browser.* desde o Chrome 148

O tipo da extensão, do app ou do tema.

Enumeração

"extension"

"hosted_app"

"packaged_app"

"legacy_packaged_app"

"theme"

"login_screen_extension"

IconInfo

Informações sobre um ícone que pertence a uma extensão, um app ou um tema.

Propriedades

  • tamanho

    número

    Um número que representa a largura e a altura do ícone. Os valores prováveis incluem (mas não se limitam a) 128, 48, 24 e 16.

  • url

    string

    O URL da imagem do ícone. Para mostrar uma versão em escala de cinza do ícone (para indicar que uma extensão está desativada, por exemplo), adicione ?grayscale=true ao final do URL.

LaunchType

Estes são todos os tipos possíveis de inicialização de apps.

Enumeração

"OPEN_AS_REGULAR_TAB"

"OPEN_AS_PINNED_TAB"

"OPEN_AS_WINDOW"

"OPEN_FULL_SCREEN"

UninstallOptions

Chrome 88+ browser.* desde o Chrome 148

Opções para lidar com a desinstalação da extensão.

Propriedades

  • showConfirmDialog

    booleano opcional

    Se uma caixa de diálogo de confirmação de desinstalação deve ser mostrada ao usuário. O padrão é "false" para desinstalações automáticas. Se uma extensão desinstalar outra, esse parâmetro será ignorado, e a caixa de diálogo sempre será mostrada.

Métodos

createAppShortcut()

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

Mostra opções para criar atalhos para um app. No Mac, só é possível criar atalhos de apps empacotados.

Parâmetros

Retorna

  • Promessa<void>

    Chrome 88+ browser.* desde o Chrome 148 
browser.management.generateAppForLink(
  url: string,
  title: string,
): Promise<ExtensionInfo>

Gerar um app para um URL. Retorna o app de favoritos gerado.

Parâmetros

  • url

    string

    O URL de uma página da Web. O esquema do URL só pode ser "http" ou "https".

  • título

    string

    O título do app gerado.

Retorna

get()

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

Retorna informações sobre a extensão, o app ou o tema instalado que tem o ID fornecido.

Parâmetros

Retorna

getAll()

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

Retorna uma lista de informações sobre as extensões e os apps instalados.

Retorna

  • Promise<ExtensionInfo[]>

    Chrome 88+ browser.* desde o Chrome 148

getPermissionWarningsById()

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

Retorna uma lista de avisos de permissão para o ID de extensão fornecido.

Parâmetros

  • ID

    string

    O ID de uma extensão já instalada.

Retorna

  • Promise<string[]>

    Chrome 88+ browser.* desde o Chrome 148

getPermissionWarningsByManifest()

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

Retorna uma lista de avisos de permissão para a string de manifesto da extensão fornecida. Observação: essa função pode ser usada sem solicitar a permissão "management" no manifesto.

Parâmetros

  • manifestStr

    string

    String JSON do manifesto da extensão.

Retorna

  • Promise<string[]>

    Chrome 88+ browser.* desde o Chrome 148

getSelf()

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

Retorna informações sobre a extensão, o app ou o tema de chamada. Observação: essa função pode ser usada sem solicitar a permissão "management" no manifesto.

Retorna

installReplacementWebApp()

Chrome 77+ browser.* desde o Chrome 148 
browser.management.installReplacementWebApp(): Promise<void>

Inicia o replacement_web_app especificado no manifesto. Solicita que o usuário instale o app, caso ainda não tenha feito isso.

Retorna

  • Promessa<void>

    Chrome 88+ browser.* desde o Chrome 148

launchApp()

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

Inicia um aplicativo.

Parâmetros

  • ID

    string

    O ID da extensão do aplicativo.

Retorna

  • Promessa<void>

    Chrome 88+ browser.* desde o Chrome 148

setEnabled()

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

Ativa ou desativa um app ou uma extensão. Na maioria dos casos, essa função precisa ser chamada no contexto de uma interação inicial (por exemplo, um gerenciador onclick para um botão) e pode apresentar ao usuário uma interface de confirmação nativa como forma de evitar abusos.

Parâmetros

  • ID

    string

    Esse precisa ser o ID de um item de management.ExtensionInfo.

  • ativado

    booleano

    Se este item deve ser ativado ou desativado.

Retorna

  • Promessa<void>

    Chrome 88+ browser.* desde o Chrome 148

setLaunchType()

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

Defina o tipo de inicialização de um app.

Parâmetros

Retorna

  • Promessa<void>

    Chrome 88+ browser.* desde o Chrome 148

uninstall()

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

Desinstala um app ou uma extensão instalada. Observação: essa função não funciona em ambientes gerenciados quando o usuário não tem permissão para desinstalar a extensão/app especificado. Se a desinstalação falhar (por exemplo, o usuário cancelar a caixa de diálogo), a promessa será rejeitada ou o callback será chamado com runtime.lastError definido.

Parâmetros

Retorna

  • Promessa<void>

    Chrome 88+ browser.* desde o Chrome 148

uninstallSelf()

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

Desinstala a extensão de chamada. Observação: essa função pode ser usada sem solicitar a permissão "management" no manifesto. Essa função não funciona em ambientes gerenciados quando o usuário não tem permissão para desinstalar a extensão/app especificado.

Parâmetros

Retorna

  • Promessa<void>

    Chrome 88+ browser.* desde o Chrome 148

Eventos

onDisabled

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

Acionado quando um app ou uma extensão é desativado.

Parâmetros

onEnabled

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

Disparado quando um app ou uma extensão é ativado.

Parâmetros

onInstalled

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

Disparado quando um app ou uma extensão é instalado.

Parâmetros

onUninstalled

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

Disparado quando um app ou uma extensão é desinstalado.

Parâmetros

  • callback

    função

    O parâmetro callback é semelhante a: 

    (id: string) => void

    • ID

      string