chrome.management

Opis

Interfejs chrome.management API umożliwia zarządzanie listą zainstalowanych i uruchomionych rozszerzeń/aplikacji. Jest to szczególnie przydatne w przypadku rozszerzeń, które zastępują wbudowaną stronę Nowa karta.

Uprawnienia

management

Aby korzystać z interfejsu API zarządzania, musisz zadeklarować uprawnienia do zarządzania w pliku manifestu rozszerzenia. Na przykład:

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

Usługi management.getPermissionWarningsByManifest(), management.uninstallSelf() i management.getSelf() nie wymagają uprawnień do zarządzania.

Typy

ExtensionDisabledReason

Chrome 44 i nowsze wersje

Przyczyna wyłączenia produktu.

Enum

ExtensionInfo

Informacje o zainstalowanym rozszerzeniu, aplikacji lub motywie.

Właściwości

  • appLaunchUrl

    ciąg znaków opcjonalny

    URL do uruchomienia (tylko w przypadku aplikacji).

  • availableLaunchTypes

    LaunchType[] opcjonalny

    Obecnie dostępne typy uruchomień (dotyczy tylko aplikacji).

  • opis

    string,

    Opis tego rozszerzenia, aplikacji lub motywu.

  • disabledReason

    Opcjonalny ExtensionDisabledReason

    Przyczyna wyłączenia produktu.

  • włączone

    boolean

    Określa, czy jest aktualnie włączona czy wyłączona.

  • homepageUrl

    ciąg znaków opcjonalny

    Adres URL strony głównej tego rozszerzenia, aplikacji lub motywu.

  • hostPermissions

    string[]

    Zwraca listę uprawnień opartych na hoście.

  • ikony

    IconInfo[] opcjonalny

    Lista z informacjami o ikonach. Pamiętaj, że odzwierciedla to tylko zawartość zadeklarowaną w pliku manifestu, a rzeczywisty obraz pod tym adresem URL może być większy lub mniejszy od zadeklarowanej wartości, dlatego rozważ użycie w tagach img wyraźnych atrybutów szerokości i wysokości odnoszącej się do tych obrazów. Więcej informacji znajdziesz w dokumentacji pliku manifestu dotyczącej ikon.

  • id

    string,

    Unikalny identyfikator rozszerzenia.

  • installType

    ExtensionInstallType

    Sposób instalacji rozszerzenia.

  • isApp

    boolean

    Wycofano

    Użyj adresu management.ExtensionInfo.type.

    Prawda, jeśli jest to aplikacja.

  • launchType

    LaunchType opcjonalnie

    Typ uruchamiania aplikacji (dotyczy tylko aplikacji).

  • mayDisable

    boolean

    Określa, czy użytkownik może wyłączyć lub odinstalować to rozszerzenie.

  • mayEnable

    wartość logiczna opcjonalna

    Chrome 62 i nowsze wersje

    Określa, czy użytkownik może włączyć to rozszerzenie. Ta wartość jest zwracana tylko w przypadku rozszerzeń, które są wyłączone.

  • nazwa

    string,

    Nazwa tego rozszerzenia, aplikacji lub motywu.

  • offlineEnabled

    boolean

    Wskazuje, czy rozszerzenie, aplikacja lub motyw deklarują, że obsługują tryb offline.

  • optionsUrl

    string,

    Adres URL strony opcji elementu (jeśli ją zawiera).

  • uprawnienia

    string[]

    Zwraca listę uprawnień opartych na interfejsie API.

  • shortName

    string,

    Krótka wersja nazwy tego rozszerzenia, aplikacji lub motywu.

  • Typ tego rozszerzenia, aplikacji lub motywu.

  • updateUrl

    ciąg znaków opcjonalny

    Adres URL aktualizacji tego rozszerzenia, aplikacji lub motywu.

  • wersja

    string,

    Wersja rozszerzenia, aplikacji lub motywu.

  • versionName

    ciąg znaków opcjonalny

    Chrome 50 i nowsze wersje

    Nazwa wersji danego rozszerzenia, aplikacji lub motywu (jeśli została określona w pliku manifestu).

ExtensionInstallType

Chrome 44 i nowsze wersje

Sposób instalacji rozszerzenia. Jedna z tych wartości: admin: rozszerzenie zostało zainstalowane zgodnie z zasadą administracyjną, development: rozszerzenie zostało załadowane w trybie programisty, normal: rozszerzenie zostało zainstalowane normalnie za pomocą pliku .crx, sideload: rozszerzenie zostało zainstalowane przez inne oprogramowanie na komputerze, other: rozszerzenie zostało zainstalowane w inny sposób.

Enum

ExtensionType

Chrome 44 i nowsze wersje

Typ tego rozszerzenia, aplikacji lub motywu.

Enum

"hosted_app"

"packaged_app"

"legacy_packaged_app"

"login_screen_extension"

IconInfo

Informacje o ikonie należącej do rozszerzenia, aplikacji lub motywu.

Właściwości

  • rozmiar

    Liczba

    Liczba reprezentująca szerokość i wysokość ikony. Prawdopodobne wartości to między innymi 128, 48, 24 i 16.

  • URL

    string,

    Adres URL obrazu ikony. Aby wyświetlić ikonę w skali szarości (np. wskazując, że rozszerzenie jest wyłączone), do adresu URL dołącz ciąg ?grayscale=true.

LaunchType

To wszystkie możliwe typy wprowadzenia aplikacji na rynek.

Enum

UninstallOptions

Chrome 88 i nowsze wersje

Opcje postępowania z odinstalowywaniem rozszerzenia.

Właściwości

  • showConfirmDialog

    wartość logiczna opcjonalna

    Określa, czy okno potwierdzenia odinstalowania powinno prosić użytkownika o potwierdzenie. W przypadku samodzielnych odinstalowań domyślna wartość to false (fałsz). Jeśli rozszerzenie odinstalowuje inne rozszerzenie, parametr ten jest ignorowany, a okno dialogowe jest zawsze wyświetlane.

Metody

createAppShortcut()

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

Wyświetl opcje tworzenia skrótów do aplikacji. Na Macu można tworzyć tylko skróty do aplikacji w pakietach.

Parametry

  • id

    string,

    Powinien to być identyfikator z elementu aplikacji management.ExtensionInfo.

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    ()=>void

Akcje powrotne

  • Promise<void>

    Chrome 88 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

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

Wygeneruj aplikację dla adresu URL. Zwraca wygenerowaną aplikację do obsługi zakładek.

Parametry

  • URL

    string,

    Adres URL strony internetowej. Schematem adresu URL może być tylko „http” lub „https”.

  • title

    string,

    Tytuł wygenerowanej aplikacji.

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    (result: ExtensionInfo)=>void

Akcje powrotne

  • Promise<ExtensionInfo>

    Chrome 88 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

get()

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

Zwraca informacje o zainstalowanym rozszerzeniu, aplikacji lub motywie o podanym identyfikatorze.

Parametry

Akcje powrotne

  • Promise<ExtensionInfo>

    Chrome 88 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

getAll()

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

Zwraca listę informacji o zainstalowanych rozszerzeniach i aplikacjach.

Parametry

Akcje powrotne

  • Promise<ExtensionInfo[]>

    Chrome 88 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

getPermissionWarningsById()

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

Zwraca listę ostrzeżeń dotyczących uprawnień dla podanego identyfikatora rozszerzenia.

Parametry

  • id

    string,

    Identyfikator już zainstalowanego rozszerzenia.

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    (permissionWarnings: string[])=>void

    • permissionWarnings

      string[]

Akcje powrotne

  • Obietnica<string[]>

    Chrome 88 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

getPermissionWarningsByManifest()

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

Zwraca listę ostrzeżeń dotyczących uprawnień dla podanego ciągu manifestu rozszerzenia. Uwaga: tej funkcji można użyć bez wysyłania prośby o uprawnienia do zarządzania w pliku manifestu.

Parametry

  • manifestStr

    string,

    Ciąg znaków JSON manifestu rozszerzenia.

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    (permissionWarnings: string[])=>void

    • permissionWarnings

      string[]

Akcje powrotne

  • Obietnica<string[]>

    Chrome 88 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

getSelf()

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

Zwraca informacje o rozszerzeniu, aplikacji lub motywie wywołującym. Uwaga: tej funkcji można użyć bez wysyłania prośby o uprawnienia do zarządzania w pliku manifestu.

Parametry

Akcje powrotne

  • Promise<ExtensionInfo>

    Chrome 88 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

installReplacementWebApp()

Obietnica Chrome w wersji 77 lub nowszej 
chrome.management.installReplacementWebApp(
  callback?: function,
)

Uruchamia zastępcze aplikacje internetowe określone w pliku manifestu. Wyświetla użytkownikowi prośbę o zainstalowanie, jeśli nie została jeszcze zainstalowana.

Parametry

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    ()=>void

Akcje powrotne

  • Promise<void>

    Chrome 88 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

launchApp()

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

Uruchamia aplikację.

Parametry

  • id

    string,

    Identyfikator rozszerzenia aplikacji.

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    ()=>void

Akcje powrotne

  • Promise<void>

    Chrome 88 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

setEnabled()

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

Włącza lub wyłącza aplikację lub rozszerzenie. W większości przypadków funkcja ta musi być wywoływana w kontekście gestu użytkownika (np. modułu do obsługi polecenia „onclick” dla przycisku) i może wyświetlić użytkownikowi natywny interfejs potwierdzenia jako sposób zapobiegania nadużyciom.

Parametry

  • id

    string,

    Powinien to być identyfikator z elementu management.ExtensionInfo.

  • włączone

    boolean

    Określa, czy element ma być włączony czy wyłączony.

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    ()=>void

Akcje powrotne

  • Promise<void>

    Chrome 88 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

setLaunchType()

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

Ustaw typ uruchamiania aplikacji.

Parametry

  • id

    string,

    Powinien to być identyfikator z elementu aplikacji management.ExtensionInfo.

  • launchType

    LaunchType

    Typ docelowego uruchomienia. Zawsze sprawdzaj ten typ uruchamiania w ExtensionInfo.availableLaunchTypes, ponieważ dostępne typy uruchomienia różnią się w zależności od platformy i konfiguracji.

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    ()=>void

Akcje powrotne

  • Promise<void>

    Chrome 88 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

uninstall()

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

Odinstalowuje aktualnie zainstalowaną aplikację lub rozszerzenie. Uwaga: ta funkcja nie działa w środowiskach zarządzanych, gdy użytkownik nie może odinstalować określonego rozszerzenia/aplikacji. Jeśli odinstalowywanie się nie powiedzie (np. użytkownik anuluje okno), obietnica zostanie odrzucona lub nastąpi wywołanie zwrotne z ustawieniem runtime.lastError.

Parametry

Akcje powrotne

  • Promise<void>

    Chrome 88 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

uninstallSelf()

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

Odinstalowuje rozszerzenie połączeń. Uwaga: tej funkcji można użyć bez wysyłania prośby o uprawnienia do zarządzania w pliku manifestu. Ta funkcja nie działa w środowiskach zarządzanych, gdy użytkownik nie może odinstalować określonego rozszerzenia/aplikacji.

Parametry

  • Opcje

    Opcjonalne UninstallOptions.

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    ()=>void

Akcje powrotne

  • Promise<void>

    Chrome 88 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

Wydarzenia

onDisabled

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

Uruchamiane, gdy aplikacja lub rozszerzenie zostały wyłączone.

Parametry

onEnabled

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

Uruchamiane po włączeniu aplikacji lub rozszerzenia.

Parametry

onInstalled

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

Uruchamiane po zainstalowaniu aplikacji lub rozszerzenia.

Parametry

onUninstalled

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

Uruchamiane, gdy aplikacja lub rozszerzenie zostało odinstalowane.

Parametry

  • wywołanie zwrotne

    funkcja

    Parametr callback wygląda tak: 

    (id: string)=>void

    • id

      string,