Descrição
A API chrome.management
oferece maneiras de gerenciar apps e extensões instalados.
Permissões
management
É necessário declarar o papel no manifesto de extensões para usar o serviço de gerenciamento API. Exemplo:
{
"name": "My extension",
...
"permissions": [
"management"
],
...
}
management.getPermissionWarningsByManifest()
, management.uninstallSelf()
e
management.getSelf()
não precisam de permissão de gerenciamento.
Tipos
ExtensionDisabledReason
Um motivo pelo qual o item está desativado.
Enumeração
"desconhecido"
"permissions_increase"
ExtensionInfo
Informações sobre uma extensão, app ou tema instalado.
Propriedades
-
appLaunchUrl
string opcional
O URL de início (presente apenas para apps).
-
availableLaunchTypes
LaunchType[] opcional
Os tipos de inicialização 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
Um 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 do ícone. Observe que isso reflete apenas o que foi declarado no manifesto, e a imagem real no URL pode ser maior ou menor do que o declarado. Por isso, você pode considerar o uso de atributos de largura e altura explícitos em tags img que fazem referência a essas imagens. Consulte a documentação do manifesto sobre ícones para saber mais detalhes.
-
id
string
O identificador exclusivo da extensão.
-
installType
Como a extensão foi instalada.
-
isApp
booleano
DescontinuadoUse
management.ExtensionInfo.type
.Verdadeiro se for um app.
-
launchType
LaunchType opcional
O tipo de inicialização do app (presente apenas para apps).
-
mayDisable
booleano
Indica se essa extensão pode ser desativada ou desinstalada pelo usuário.
-
mayEnable
booleano opcional
Chrome 62 ou superiorDefine 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 oferece suporte 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 com base na API.
-
Apelido
string
Uma versão curta do nome da extensão, do app ou do tema.
-
tipo
O tipo da extensão, do app ou do tema.
-
updateUrl
string opcional
O URL de atualização desta extensão, app ou tema.
-
version
string
A versão da extensão, do app ou do tema.
-
versionName
string opcional
Chrome 50 ou superiorÉ o nome da versão da extensão, do app ou do tema, se houver algum especificado no manifesto.
ExtensionInstallType
Como a extensão foi instalada. Um de
admin
: a extensão foi instalada devido a uma política administrativa.
development
: a extensão foi carregada e 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
"administrador"
"desenvolvimento"
"normal"
"sideload"
"outro"
ExtensionType
O tipo da extensão, do app ou do tema.
Enumeração
"extensão"
"host_app"
"packaged_app"
"legacy_packaged_app",
"tema"
"login_screen_extension"
IconInfo
Informações sobre um ícone pertencente a uma extensão, app ou tema.
Propriedades
-
tamanho
number
Um número que representa a largura e a altura do ícone. Os valores prováveis incluem, entre outros, 128, 48, 24 e 16.
-
url
string
É o URL dessa imagem de ícone. Para mostrar uma versão em escala de cinza do ícone (para indicar que uma extensão está desativada, por exemplo), anexe
?grayscale=true
ao URL.
LaunchType
Todos esses são 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
Opções de como 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 ou não solicitar 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 será sempre exibida.
Métodos
createAppShortcut()
chrome.management.createAppShortcut(
id: string,
callback?: function,
)
Mostrar opções para criar atalhos para um app. No Mac, apenas atalhos de apps empacotados podem ser criados.
Parâmetros
-
id
string
Esse precisa ser o ID de um item de app de
management.ExtensionInfo
. -
callback
função opcional
O parâmetro
callback
tem esta aparência:() => void
Retorna
-
Promessa<void>
Chrome 88 ou superiorO Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.
generateAppForLink()
chrome.management.generateAppForLink(
url: string,
title: string,
callback?: function,
)
Gere 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.
-
callback
função opcional
O parâmetro
callback
tem esta aparência:(result: ExtensionInfo) => void
-
resultado
-
Retorna
-
Promise<ExtensionInfo>
Chrome 88 ou superiorO Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.
get()
chrome.management.get(
id: string,
callback?: function,
)
Retorna informações sobre a extensão, o app ou o tema instalado que tem o ID fornecido.
Parâmetros
-
id
string
O ID de um item de
management.ExtensionInfo
. -
callback
função opcional
O parâmetro
callback
tem esta aparência:(result: ExtensionInfo) => void
-
resultado
-
Retorna
-
Promise<ExtensionInfo>
Chrome 88 ou superiorO Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.
getAll()
chrome.management.getAll(
callback?: function,
)
Retorna uma lista de informações sobre as extensões e os apps instalados.
Parâmetros
-
callback
função opcional
O parâmetro
callback
tem esta aparência:(result: ExtensionInfo[]) => void
-
resultado
-
Retorna
-
Promise<ExtensionInfo[]>
Chrome 88 ou superiorO Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.
getPermissionWarningsById()
chrome.management.getPermissionWarningsById(
id: string,
callback?: function,
)
Retorna uma lista de avisos de permissão para o ID de extensão especificado.
Parâmetros
-
id
string
O ID de uma extensão já instalada.
-
callback
função opcional
O parâmetro
callback
tem esta aparência:(permissionWarnings: string[]) => void
-
permissionWarnings
string[]
-
Retorna
-
Promise<string[]>
Chrome 88 ou superiorO Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.
getPermissionWarningsByManifest()
chrome.management.getPermissionWarningsByManifest(
manifestStr: string,
callback?: function,
)
Retorna uma lista de avisos de permissão para a string do manifesto de extensão especificada. Observação: essa função pode ser usada sem a solicitação do atributo "management" no manifesto.
Parâmetros
-
manifestStr
string
String JSON do manifesto da extensão.
-
callback
função opcional
O parâmetro
callback
tem esta aparência:(permissionWarnings: string[]) => void
-
permissionWarnings
string[]
-
Retorna
-
Promise<string[]>
Chrome 88 ou superiorO Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.
getSelf()
chrome.management.getSelf(
callback?: function,
)
Retorna informações sobre o app, o tema ou a extensão de chamada. Observação: essa função pode ser usada sem a solicitação do atributo "management" no manifesto.
Parâmetros
-
callback
função opcional
O parâmetro
callback
tem esta aparência:(result: ExtensionInfo) => void
-
resultado
-
Retorna
-
Promise<ExtensionInfo>
Chrome 88 ou superiorO Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.
installReplacementWebApp()
chrome.management.installReplacementWebApp(
callback?: function,
)
Inicia o substituto_web_app especificado no manifesto. Solicita que o usuário instale, caso ainda não tenha feito isso.
Parâmetros
-
callback
função opcional
O parâmetro
callback
tem esta aparência:() => void
Retorna
-
Promessa<void>
Chrome 88 ou superiorO Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.
launchApp()
chrome.management.launchApp(
id: string,
callback?: function,
)
Inicia um aplicativo.
Parâmetros
-
id
string
O ID da extensão do aplicativo.
-
callback
função opcional
O parâmetro
callback
tem esta aparência:() => void
Retorna
-
Promessa<void>
Chrome 88 ou superiorO Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.
setEnabled()
chrome.management.setEnabled(
id: string,
enabled: boolean,
callback?: function,
)
Ativa ou desativa um app ou extensão. Na maioria dos casos, essa função precisa ser chamada no contexto de um gesto do usuário (por exemplo, um gerenciador "onclick" para um botão) e pode apresentar ao usuário uma interface de confirmação nativa como uma forma de evitar abusos.
Parâmetros
-
id
string
Precisa ser o ID de um item de
management.ExtensionInfo
. -
ativado
booleano
Indica se este item deve ser ativado ou desativado.
-
callback
função opcional
O parâmetro
callback
tem esta aparência:() => void
Retorna
-
Promessa<void>
Chrome 88 ou superiorO Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.
setLaunchType()
chrome.management.setLaunchType(
id: string,
launchType: LaunchType,
callback?: function,
)
Define o tipo de lançamento de um app.
Parâmetros
-
id
string
Esse precisa ser o ID de um item de app de
management.ExtensionInfo
. -
launchType
O tipo de inicialização de destino. Sempre verifique se esse tipo de inicialização está em
ExtensionInfo.availableLaunchTypes
, porque os tipos de inicialização disponíveis variam em diferentes plataformas e configurações. -
callback
função opcional
O parâmetro
callback
tem esta aparência:() => void
Retorna
-
Promessa<void>
Chrome 88 ou superiorO Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.
uninstall()
chrome.management.uninstall(
id: string,
options?: UninstallOptions,
callback?: function,
)
Desinstala um app ou extensão atualmente instalado. Observação: esta função não funciona em ambientes gerenciados quando o usuário não tem permissão para desinstalar a extensão ou o aplicativo 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
-
id
string
Precisa ser o ID de um item de
management.ExtensionInfo
. -
opções
UninstallOptions opcional
-
callback
função opcional
O parâmetro
callback
tem esta aparência:() => void
Retorna
-
Promessa<void>
Chrome 88 ou superiorO Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.
uninstallSelf()
chrome.management.uninstallSelf(
options?: UninstallOptions,
callback?: function,
)
Desinstala a extensão de chamada. Observação: essa função pode ser usada sem solicitar a permissão "management" no manifesto. Esta função não funciona em ambientes gerenciados quando o usuário não tem permissão para desinstalar a extensão ou o app especificado.
Parâmetros
-
opções
UninstallOptions opcional
-
callback
função opcional
O parâmetro
callback
tem esta aparência:() => void
Retorna
-
Promessa<void>
Chrome 88 ou superiorO Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.
Eventos
onDisabled
chrome.management.onDisabled.addListener(
callback: function,
)
Disparado quando um app ou extensão é desativado.
Parâmetros
-
callback
função
O parâmetro
callback
tem esta aparência:(info: ExtensionInfo) => void
-
informações
-
onEnabled
chrome.management.onEnabled.addListener(
callback: function,
)
Disparado quando um app ou extensão é ativado.
Parâmetros
-
callback
função
O parâmetro
callback
tem esta aparência:(info: ExtensionInfo) => void
-
informações
-
onInstalled
chrome.management.onInstalled.addListener(
callback: function,
)
Disparado quando um app ou extensão é instalado.
Parâmetros
-
callback
função
O parâmetro
callback
tem esta aparência:(info: ExtensionInfo) => void
-
informações
-
onUninstalled
chrome.management.onUninstalled.addListener(
callback: function,
)
Disparado quando um app ou extensão é desinstalado.
Parâmetros
-
callback
função
O parâmetro
callback
tem esta aparência:(id: string) => void
-
id
string
-