chrome.management

Opis

Interfejs chrome.management API umożliwia zarządzanie zainstalowanymi aplikacjami i rozszerzeniami.

Uprawnienia

management

Plik manifestu

Aby korzystać z interfejsu management API, musisz zadeklarować uprawnienie „management” w pliku manifestu rozszerzenia. Na przykład:

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

management.getPermissionWarningsByManifest, management.uninstallSelf i management.getSelf nie wymagają uprawnień do zarządzania.

Typy

ExtensionDisabledReason

Chrome 44 lub nowszy

Powód wyłączenia produktu.

Typ wyliczeniowy

"unknown"

"permissions_increase"

ExtensionInfo

Informacje o zainstalowanym rozszerzeniu, aplikacji lub motywie.

Właściwości

  • appLaunchUrl

    string opcjonalny

    Adres URL uruchomienia (występuje tylko w przypadku aplikacji).

  • availableLaunchTypes

    LaunchType[] opcjonalny

    Obecnie dostępne typy uruchamiania (występują tylko w przypadku aplikacji).

  • opis

    ciąg znaków

    Opis tego rozszerzenia, aplikacji lub motywu.

  • disabledReason

    ExtensionDisabledReason opcjonalny

    Powód wyłączenia produktu.

  • włączone

    Wartość logiczna

    Czy jest obecnie włączona czy wyłączona.

  • homepageUrl

    string opcjonalny

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

  • hostPermissions

    string[]

    Zwraca listę uprawnień dotyczących hosta.

  • ikony,

    IconInfo[] opcjonalnie

    Lista informacji o ikonach. Pamiętaj, że odzwierciedla to tylko to, co zostało zadeklarowane w pliku manifestu, a rzeczywisty obraz pod tym adresem URL może być większy lub mniejszy niż zadeklarowany, więc możesz rozważyć użycie w tagach img odwołujących się do tych obrazów atrybutów szerokości i wysokości. Więcej informacji znajdziesz w dokumentacji manifestu dotyczącej ikon.

  • id

    ciąg znaków

    Unikalny identyfikator rozszerzenia.

  • installType

    ExtensionInstallType

    Sposób instalacji rozszerzenia.

  • isApp

    Wartość logiczna

    Wycofano

    Użyj management.ExtensionInfo.type.

    Wartość „Prawda”, jeśli jest to aplikacja.

  • launchType

    LaunchType opcjonalny

    Typ uruchamiania aplikacji (występuje tylko w przypadku aplikacji).

  • mayDisable

    Wartość logiczna

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

  • mayEnable

    wartość logiczna opcjonalna

    Chrome 62 lub nowsza

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

  • nazwa

    ciąg znaków

    Nazwa tego rozszerzenia, aplikacji lub motywu.

  • offlineEnabled

    Wartość logiczna

    Określa, czy rozszerzenie, aplikacja lub motyw deklaruje obsługę trybu offline.

  • optionsUrl

    ciąg znaków

    Adres URL strony z opcjami produktu, jeśli taka istnieje.

  • uprawnienia

    string[]

    Zwraca listę uprawnień opartych na interfejsie API.

  • shortName

    ciąg znaków

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

  • Typ tego rozszerzenia, aplikacji lub motywu.

  • updateUrl

    string opcjonalny

    Adres URL aktualizacji tego rozszerzenia, aplikacji lub motywu.

  • wersja

    ciąg znaków

    Wersja tego rozszerzenia, aplikacji lub motywu.

  • versionName

    string opcjonalny

    Chrome w wersji 50 lub nowszej

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

ExtensionInstallType

Chrome 44 lub nowszy

Sposób instalacji rozszerzenia. Jeden z tych przypadków:admin: rozszerzenie zostało zainstalowane z powodu zasad administracyjnych;development: rozszerzenie zostało wczytane w trybie deweloperskim;normal: rozszerzenie zostało zainstalowane normalnie przy użyciu pliku .crx;sideload: rozszerzenie zostało zainstalowane przez inne oprogramowanie na komputerze;other: rozszerzenie zostało zainstalowane w inny sposób.

Typ wyliczeniowy

„admin”

„development”

„normal”

„sideload”

„other”

ExtensionType

Chrome 44 lub nowszy

Typ tego rozszerzenia, aplikacji lub motywu.

Typ wyliczeniowy

„extension”

„hosted_app”

"packaged_app"

"legacy_packaged_app"

„theme”

"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 m.in. 128, 48, 24 i 16.

  • URL

    ciąg znaków

    Adres URL tego obrazu ikony. Aby wyświetlić ikonę w odcieniach szarości (np. aby wskazać, że rozszerzenie jest wyłączone), dodaj do adresu URL znak ?grayscale=true.

LaunchType

Są to wszystkie możliwe typy uruchamiania aplikacji.

Typ wyliczeniowy

"OPEN_AS_REGULAR_TAB"

"OPEN_AS_PINNED_TAB"

„OPEN_AS_WINDOW”

„OPEN_FULL_SCREEN”

UninstallOptions

Chrome 88 lub nowsza

Opcje dotyczące sposobu obsługi odinstalowywania rozszerzenia.

Właściwości

  • showConfirmDialog

    wartość logiczna opcjonalna

    Określa, czy użytkownikowi ma się wyświetlać okno potwierdzenia odinstalowania. W przypadku samodzielnego odinstalowywania domyślna wartość to fałsz. Jeśli rozszerzenie odinstaluje inne rozszerzenie, ten parametr jest ignorowany, a okno dialogowe jest zawsze wyświetlane.

Metody

createAppShortcut()

Obietnica 
chrome.management.createAppShortcut(
  id: string,
  callback?: function,
): Promise<void>

Wyświetla opcje tworzenia skrótów do aplikacji. Na komputerach Mac można tworzyć tylko skróty do aplikacji pakietowych.

Parametry

  • id

    ciąg znaków

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

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    () => void

Zwroty

  • Promise<void>

    Chrome 88 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

Obietnica 
chrome.management.generateAppForLink(
  url: string,
  title: string,
  callback?: function,
): Promise<ExtensionInfo>

Wygeneruj aplikację dla adresu URL. Zwraca wygenerowaną aplikację z zakładkami.

Parametry

  • URL

    ciąg znaków

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

  • tytuł

    ciąg znaków

    Tytuł wygenerowanej aplikacji.

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    (result: ExtensionInfo) => void

Zwroty

  • Promise<ExtensionInfo>

    Chrome 88 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

get()

Obietnica 
chrome.management.get(
  id: string,
  callback?: function,
): Promise<ExtensionInfo>

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

Parametry

Zwroty

  • Promise<ExtensionInfo>

    Chrome 88 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

getAll()

Obietnica 
chrome.management.getAll(
  callback?: function,
): Promise<ExtensionInfo[]>

Zwraca listę informacji o zainstalowanych rozszerzeniach i aplikacjach.

Parametry

Zwroty

  • Promise<ExtensionInfo[]>

    Chrome 88 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

getPermissionWarningsById()

Obietnica 
chrome.management.getPermissionWarningsById(
  id: string,
  callback?: function,
): Promise<string[]>

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

Parametry

  • id

    ciąg znaków

    Identyfikator już zainstalowanego rozszerzenia.

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    (permissionWarnings: string[]) => void

    • permissionWarnings

      string[]

Zwroty

  • Promise<string[]>

    Chrome 88 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

getPermissionWarningsByManifest()

Obietnica 
chrome.management.getPermissionWarningsByManifest(
  manifestStr: string,
  callback?: function,
): Promise<string[]>

Zwraca listę ostrzeżeń dotyczących uprawnień dla podanego ciągu znaków pliku manifestu rozszerzenia. Uwaga: tej funkcji można używać bez proszenia o uprawnienie „management” w pliku manifestu.

Parametry

  • manifestStr

    ciąg znaków

    Ciąg JSON manifestu rozszerzenia.

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    (permissionWarnings: string[]) => void

    • permissionWarnings

      string[]

Zwroty

  • Promise<string[]>

    Chrome 88 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

getSelf()

Obietnica 
chrome.management.getSelf(
  callback?: function,
): Promise<ExtensionInfo>

Zwraca informacje o rozszerzeniu, aplikacji lub motywie wywołującym. Uwaga: tej funkcji można używać bez proszenia o uprawnienie „management” w pliku manifestu.

Parametry

Zwroty

  • Promise<ExtensionInfo>

    Chrome 88 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

installReplacementWebApp()

Promise Chrome 77 lub nowszy 
chrome.management.installReplacementWebApp(
  callback?: function,
): Promise<void>

Uruchamia aplikację replacement_web_app określoną w pliku manifestu. Jeśli aplikacja nie jest jeszcze zainstalowana, wyświetla prośbę o jej zainstalowanie.

Parametry

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    () => void

Zwroty

  • Promise<void>

    Chrome 88 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

launchApp()

Obietnica 
chrome.management.launchApp(
  id: string,
  callback?: function,
): Promise<void>

Uruchamia aplikację.

Parametry

  • id

    ciąg znaków

    Identyfikator rozszerzenia aplikacji.

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    () => void

Zwroty

  • Promise<void>

    Chrome 88 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

setEnabled()

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

Włącza lub wyłącza aplikację lub rozszerzenie. W większości przypadków ta funkcja musi być wywoływana w kontekście działania użytkownika (np. w obsłudze zdarzenia onclick przycisku) i może wyświetlać użytkownikowi natywny interfejs potwierdzenia, aby zapobiec nadużyciom.

Parametry

  • id

    ciąg znaków

    Powinien to być identyfikator elementu z management.ExtensionInfo.

  • włączone

    Wartość logiczna

    Wskazuje, czy ten element ma być włączony czy wyłączony.

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    () => void

Zwroty

  • Promise<void>

    Chrome 88 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

setLaunchType()

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

Ustaw typ uruchamiania aplikacji.

Parametry

  • id

    ciąg znaków

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

  • launchType

    LaunchType

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

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    () => void

Zwroty

  • Promise<void>

    Chrome 88 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

uninstall()

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

Odinstalowuje obecnie zainstalowaną aplikację lub rozszerzenie. Uwaga: ta funkcja nie działa w środowiskach zarządzanych, w których użytkownik nie może odinstalować określonego rozszerzenia lub aplikacji. Jeśli odinstalowanie się nie powiedzie (np. użytkownik zamknie okno), obietnica zostanie odrzucona lub wywołanie zwrotne zostanie wywołane z ustawioną wartością runtime.lastError.

Parametry

Zwroty

  • Promise<void>

    Chrome 88 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

uninstallSelf()

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

Odinstalowuje rozszerzenie do połączeń. Uwaga: tej funkcji można używać bez proszenia o uprawnienie „management” w pliku manifestu. Ta funkcja nie działa w środowiskach zarządzanych, gdy użytkownik nie może odinstalować określonego rozszerzenia lub aplikacji.

Parametry

  • Opcje

    UninstallOptions opcjonalny

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    () => void

Zwroty

  • Promise<void>

    Chrome 88 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

Wydarzenia

onDisabled

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

Uruchamiane, gdy aplikacja lub rozszerzenie zostaną wyłączone.

Parametry

onEnabled

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

Uruchamiane, gdy aplikacja lub rozszerzenie zostaną włączone.

Parametry

onInstalled

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

Uruchamiane po zainstalowaniu aplikacji lub rozszerzenia.

Parametry

onUninstalled

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

Wywoływane po odinstalowaniu aplikacji lub rozszerzenia.

Parametry

  • callback

    funkcja

    Parametr callback wygląda tak:

    (id: string) => void

    • id

      ciąg znaków