browser.management

Deskripsi

chrome.management API menyediakan cara untuk mengelola aplikasi dan ekstensi yang diinstal.

Izin

management

Anda harus mendeklarasikan izin "pengelolaan" di manifes ekstensi untuk menggunakan API pengelolaan. Contoh:

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

management.getPermissionWarningsByManifest(), management.uninstallSelf(), dan management.getSelf() tidak memerlukan izin pengelolaan.

Jenis

ExtensionDisabledReason

Chrome 44+ browser.* sejak Chrome 148

Alasan item dinonaktifkan.

Enum

"unknown"

"permissions_increase"

ExtensionInfo

Informasi tentang ekstensi, aplikasi, atau tema yang diinstal.

Properti

  • appLaunchUrl

    string opsional

    URL peluncuran (hanya ada untuk aplikasi).

  • availableLaunchTypes

    LaunchType[] opsional

    Jenis peluncuran yang saat ini tersedia (hanya ada untuk aplikasi).

  • deskripsi

    string

    Deskripsi ekstensi, aplikasi, atau tema ini.

  • disabledReason

    ExtensionDisabledReason opsional

    Alasan item dinonaktifkan.

  • aktif

    boolean

    Apakah saat ini diaktifkan atau dinonaktifkan.

  • homepageUrl

    string opsional

    URL halaman beranda ekstensi, aplikasi, atau tema ini.

  • hostPermissions

    string[]

    Menampilkan daftar izin berbasis host.

  • ikon

    IconInfo[] opsional

    Daftar informasi ikon. Perhatikan bahwa ini hanya mencerminkan apa yang dideklarasikan dalam manifes, dan gambar sebenarnya di URL tersebut mungkin lebih besar atau lebih kecil dari yang dideklarasikan, jadi sebaiknya gunakan atribut lebar dan tinggi eksplisit pada tag img yang mereferensikan gambar ini. Lihat dokumentasi manifes tentang ikon untuk mengetahui detail selengkapnya.

  • id

    string

    ID unik ekstensi.

  • installType

    ExtensionInstallType

    Cara ekstensi diinstal.

  • isApp

    boolean

    Tidak digunakan lagi

    Gunakan management.ExtensionInfo.type.

    True jika ini adalah aplikasi.

  • launchType

    LaunchType opsional

    Jenis peluncuran aplikasi (hanya ada untuk aplikasi).

  • mayDisable

    boolean

    Apakah ekstensi ini dapat dinonaktifkan atau di-uninstal oleh pengguna.

  • mayEnable

    boolean opsional

    Chrome 62+ browser.* sejak Chrome 148

    Apakah ekstensi ini dapat diaktifkan oleh pengguna. Ini hanya ditampilkan untuk ekstensi yang tidak diaktifkan.

  • nama

    string

    Nama ekstensi, aplikasi, atau tema ini.

  • offlineEnabled

    boolean

    Apakah ekstensi, aplikasi, atau tema menyatakan bahwa ekstensi, aplikasi, atau tema tersebut mendukung mode offline.

  • optionsUrl

    string

    URL untuk halaman opsi item, jika ada.

  • izin

    string[]

    Menampilkan daftar izin berbasis API.

  • shortName

    string

    Versi singkat nama ekstensi, aplikasi, atau tema ini.

  • Jenis ekstensi, aplikasi, atau tema ini.

  • updateUrl

    string opsional

    URL update ekstensi, aplikasi, atau tema ini.

  • versi

    string

    Versi ekstensi, aplikasi, atau tema ini.

  • versionName

    string opsional

    Chrome 50+ browser.* sejak Chrome 148

    Nama versi ekstensi, aplikasi, atau tema ini jika manifes menentukannya.

ExtensionInstallType

Chrome 44+ browser.* sejak Chrome 148

Cara ekstensi diinstal. Salah satu dari admin: Ekstensi diinstal karena kebijakan administratif, development: Ekstensi dimuat tanpa paket dalam mode developer, normal: Ekstensi diinstal secara normal melalui file .crx, sideload: Ekstensi diinstal oleh software lain di perangkat, other: Ekstensi diinstal dengan cara lain.

Enum

"admin"

"development"

"normal"

"sideload"

"other"

ExtensionType

Chrome 44+ browser.* sejak Chrome 148

Jenis ekstensi, aplikasi, atau tema ini.

Enum

"extension"

"hosted_app"

"packaged_app"

"legacy_packaged_app"

"theme"

"login_screen_extension"

IconInfo

Informasi tentang ikon milik ekstensi, aplikasi, atau tema.

Properti

  • ukuran

    angka

    Angka yang mewakili lebar dan tinggi ikon. Nilai yang mungkin mencakup (tetapi tidak terbatas pada) 128, 48, 24, dan 16.

  • url

    string

    URL untuk gambar ikon ini. Untuk menampilkan ikon versi hitam putih (misalnya, untuk menunjukkan bahwa ekstensi dinonaktifkan), tambahkan ?grayscale=true ke URL.

LaunchType

Berikut adalah semua kemungkinan jenis peluncuran aplikasi.

Enum

"OPEN_AS_REGULAR_TAB"

"OPEN_AS_PINNED_TAB"

"OPEN_AS_WINDOW"

"OPEN_FULL_SCREEN"

UninstallOptions

Chrome 88+ browser.* sejak Chrome 148

Opsi untuk menangani uninstal ekstensi.

Properti

  • showConfirmDialog

    boolean opsional

    Apakah dialog konfirmasi uninstal harus meminta konfirmasi pengguna atau tidak. Nilai defaultnya adalah false untuk uninstal mandiri. Jika ekstensi meng-uninstal ekstensi lain, parameter ini akan diabaikan dan dialog akan selalu ditampilkan.

Metode

createAppShortcut()

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

Menampilkan opsi untuk membuat pintasan aplikasi. Di Mac, hanya pintasan aplikasi dalam paket yang dapat dibuat.

Parameter

Hasil

  • Promise<void>

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

Membuat aplikasi untuk URL. Menampilkan aplikasi bookmark yang dihasilkan.

Parameter

  • url

    string

    URL halaman web. Skema URL hanya boleh "http" atau "https".

  • judul

    string

    Judul aplikasi yang dihasilkan.

Hasil

get()

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

Menampilkan informasi tentang ekstensi, aplikasi, atau tema terinstal yang memiliki ID yang diberikan.

Parameter

Hasil

getAll()

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

Menampilkan daftar informasi tentang ekstensi dan aplikasi yang diinstal.

Hasil

getPermissionWarningsById()

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

Menampilkan daftar peringatan izin untuk ID ekstensi yang diberikan.

Parameter

  • id

    string

    ID ekstensi yang sudah diinstal.

Hasil

  • Promise<string[]>

    Chrome 88+ browser.* sejak Chrome 148

getPermissionWarningsByManifest()

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

Menampilkan daftar peringatan izin untuk string manifes ekstensi yang diberikan. Catatan: Fungsi ini dapat digunakan tanpa meminta izin 'management' dalam manifes.

Parameter

  • manifestStr

    string

    String JSON manifes ekstensi.

Hasil

  • Promise<string[]>

    Chrome 88+ browser.* sejak Chrome 148

getSelf()

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

Menampilkan informasi tentang ekstensi, aplikasi, atau tema yang memanggil. Catatan: Fungsi ini dapat digunakan tanpa meminta izin 'management' dalam manifes.

Hasil

installReplacementWebApp()

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

Meluncurkan replacement_web_app yang ditentukan dalam manifes. Meminta pengguna untuk menginstal jika belum diinstal.

Hasil

  • Promise<void>

    Chrome 88+ browser.* sejak Chrome 148

launchApp()

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

Meluncurkan aplikasi.

Parameter

  • id

    string

    ID ekstensi aplikasi.

Hasil

  • Promise<void>

    Chrome 88+ browser.* sejak Chrome 148

setEnabled()

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

Mengaktifkan atau menonaktifkan aplikasi atau ekstensi. Pada umumnya, fungsi ini harus dipanggil dalam konteks gestur pengguna (misalnya, pengendali onclick untuk tombol), dan dapat menampilkan UI konfirmasi native kepada pengguna sebagai cara untuk mencegah penyalahgunaan.

Parameter

  • id

    string

    ID ini harus berupa ID dari item management.ExtensionInfo.

  • aktif

    boolean

    Apakah item ini harus diaktifkan atau dinonaktifkan.

Hasil

  • Promise<void>

    Chrome 88+ browser.* sejak Chrome 148

setLaunchType()

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

Menetapkan jenis peluncuran aplikasi.

Parameter

Hasil

  • Promise<void>

    Chrome 88+ browser.* sejak Chrome 148

uninstall()

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

Meng-uninstal aplikasi atau ekstensi yang saat ini diinstal. Catatan: Fungsi ini tidak berfungsi di lingkungan terkelola jika pengguna tidak diizinkan meng-uninstal ekstensi/aplikasi yang ditentukan. Jika uninstal gagal (misalnya, pengguna membatalkan dialog), promise akan ditolak atau callback akan dipanggil dengan runtime.lastError ditetapkan.

Parameter

Hasil

  • Promise<void>

    Chrome 88+ browser.* sejak Chrome 148

uninstallSelf()

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

Meng-uninstal ekstensi panggilan. Catatan: Fungsi ini dapat digunakan tanpa meminta izin 'management' dalam manifes. Fungsi ini tidak berfungsi di lingkungan terkelola jika pengguna tidak diizinkan meng-uninstal ekstensi/aplikasi yang ditentukan.

Parameter

Hasil

  • Promise<void>

    Chrome 88+ browser.* sejak Chrome 148

Acara

onDisabled

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

Diaktifkan saat aplikasi atau ekstensi telah dinonaktifkan.

Parameter

onEnabled

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

Diaktifkan saat aplikasi atau ekstensi telah diaktifkan.

Parameter

onInstalled

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

Diaktifkan saat aplikasi atau ekstensi telah diinstal.

Parameter

onUninstalled

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

Diaktifkan saat aplikasi atau ekstensi telah di-uninstal.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti: 

    (id: string) => void

    • id

      string