chrome.management

Deskripsi

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

Izin

management

Manifes

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

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

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

Jenis

ExtensionDisabledReason

Chrome 44+

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 tersedia saat ini (hanya ada untuk aplikasi).

  • deskripsi

    string

    Deskripsi ekstensi, aplikasi, atau tema ini.

  • disabledReason

    ExtensionDisabledReason opsional

    Alasan item dinonaktifkan.

  • diaktifkan

    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 hal ini hanya mencerminkan apa yang dideklarasikan dalam manifes, dan gambar sebenarnya di URL tersebut mungkin lebih besar atau lebih kecil daripada yang dideklarasikan, jadi Anda dapat mempertimbangkan untuk menggunakan 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.

    Benar 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+

    Apakah ekstensi ini dapat diaktifkan oleh pengguna. Nilai 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 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+

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

ExtensionInstallType

Chrome 44+

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

Enum

"admin"

"pengembangan"

"normal"

"sideload"

"lainnya"

ExtensionType

Chrome 44+

Jenis ekstensi, aplikasi, atau tema ini.

Enum

"ekstensi"

"hosted_app"

"packaged_app"

"legacy_packaged_app"

"tema"

"login_screen_extension"

IconInfo

Informasi tentang ikon milik ekstensi, aplikasi, atau tema.

Properti

  • ukuran

    angka

    Angka yang merepresentasikan 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 semua jenis peluncuran aplikasi yang mungkin.

Enum

"OPEN_AS_REGULAR_TAB"

"OPEN_AS_PINNED_TAB"

"OPEN_AS_WINDOW"

"OPEN_FULL_SCREEN"

UninstallOptions

Chrome 88+

Opsi untuk cara menangani peng-uninstalan ekstensi.

Properti

  • showConfirmDialog

    boolean opsional

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

Metode

createAppShortcut()

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

Opsi tampilan untuk membuat pintasan aplikasi. Di Mac, hanya pintasan aplikasi yang dikemas yang dapat dibuat.

Parameter

  • id

    string

    Nilai ini harus berupa ID dari item aplikasi management.ExtensionInfo.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    () => void

Hasil

  • Promise<void>

    Chrome 88+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

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

Membuat aplikasi untuk URL. Menampilkan aplikasi bookmark yang dibuat.

Parameter

  • url

    string

    URL halaman web. Skema URL hanya dapat berupa "http" atau "https".

  • judul

    string

    Judul aplikasi yang dihasilkan.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (result: ExtensionInfo) => void

Hasil

  • Promise<ExtensionInfo>

    Chrome 88+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

get()

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

Menampilkan informasi tentang ekstensi, aplikasi, atau tema yang diinstal yang memiliki ID tertentu.

Parameter

Hasil

  • Promise<ExtensionInfo>

    Chrome 88+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

getAll()

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

Menampilkan daftar informasi tentang ekstensi dan aplikasi yang diinstal.

Parameter

Hasil

  • Promise<ExtensionInfo[]>

    Chrome 88+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

getPermissionWarningsById()

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

Menampilkan daftar peringatan izin untuk ID ekstensi tertentu.

Parameter

  • id

    string

    ID ekstensi yang sudah diinstal.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (permissionWarnings: string[]) => void

    • permissionWarnings

      string[]

Hasil

  • Promise<string[]>

    Chrome 88+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

getPermissionWarningsByManifest()

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

Menampilkan daftar peringatan izin untuk string manifes ekstensi tertentu. Catatan: Fungsi ini dapat digunakan tanpa meminta izin 'pengelolaan' dalam manifes.

Parameter

  • manifestStr

    string

    String JSON manifes ekstensi.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (permissionWarnings: string[]) => void

    • permissionWarnings

      string[]

Hasil

  • Promise<string[]>

    Chrome 88+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

getSelf()

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

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

Parameter

Hasil

  • Promise<ExtensionInfo>

    Chrome 88+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

installReplacementWebApp()

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

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

Parameter

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    () => void

Hasil

  • Promise<void>

    Chrome 88+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

launchApp()

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

Meluncurkan aplikasi.

Parameter

  • id

    string

    ID ekstensi aplikasi.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    () => void

Hasil

  • Promise<void>

    Chrome 88+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

setEnabled()

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

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

Parameter

  • id

    string

    Nilai ini harus berupa ID dari item management.ExtensionInfo.

  • diaktifkan

    boolean

    Apakah item ini harus diaktifkan atau dinonaktifkan.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    () => void

Hasil

  • Promise<void>

    Chrome 88+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

setLaunchType()

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

Menetapkan jenis peluncuran aplikasi.

Parameter

  • id

    string

    Nilai ini harus berupa ID dari item aplikasi management.ExtensionInfo.

  • launchType

    LaunchType

    Jenis peluncuran target. Selalu periksa dan pastikan jenis peluncuran ini ada di ExtensionInfo.availableLaunchTypes, karena jenis peluncuran yang tersedia berbeda-beda di berbagai platform dan konfigurasi.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    () => void

Hasil

  • Promise<void>

    Chrome 88+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

uninstall()

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

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

Parameter

Hasil

  • Promise<void>

    Chrome 88+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

uninstallSelf()

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

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

Parameter

  • opsi

    UninstallOptions opsional

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    () => void

Hasil

  • Promise<void>

    Chrome 88+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

Acara

onDisabled

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

Diaktifkan saat aplikasi atau ekstensi telah dinonaktifkan.

Parameter

onEnabled

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

Diaktifkan saat aplikasi atau ekstensi telah diaktifkan.

Parameter

onInstalled

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

Diaktifkan saat aplikasi atau ekstensi telah diinstal.

Parameter

onUninstalled

chrome.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