chrome.permissions

Deskripsi

Konsep dan penggunaan

Peringatan izin ada untuk menjelaskan kemampuan yang diberikan oleh API, tetapi beberapa peringatan ini mungkin tidak jelas. Permissions API memungkinkan developer menjelaskan peringatan izin dan memperkenalkan fitur baru secara bertahap yang memberi pengguna pengantar ekstensi bebas risiko. Dengan cara ini, pengguna dapat menentukan seberapa banyak akses yang ingin mereka berikan dan fitur mana yang ingin mereka aktifkan.

Misalnya, fungsi inti ekstensi izin opsional menggantikan halaman tab baru. Salah satu fitur menampilkan sasaran pengguna untuk hari ini. Fitur ini hanya memerlukan izin penyimpanan, yang tidak termasuk peringatan. Ekstensi ini memiliki fitur tambahan yang dapat diaktifkan pengguna dengan mengklik tombol berikut:

Menampilkan situs teratas milik pengguna memerlukan izin topSites, yang memiliki peringatan berikut.

Menerapkan izin opsional

Langkah 1: Tentukan izin yang diperlukan dan yang bersifat opsional

Ekstensi dapat mendeklarasikan izin yang diperlukan dan opsional. Secara umum, Anda harus:

• Gunakan izin yang diperlukan jika diperlukan untuk fungsi dasar ekstensi Anda.
• Gunakan izin opsional jika diperlukan untuk fitur opsional di ekstensi Anda.

Keuntungan izin yang diperlukan:

• Lebih sedikit perintah: Ekstensi dapat meminta pengguna satu kali untuk menyetujui semua izin.
• Pengembangan yang lebih sederhana: Izin yang diperlukan dijamin ada.

Keuntungan izin opsional:

• Keamanan yang lebih baik: Ekstensi berjalan dengan lebih sedikit izin karena pengguna hanya mengaktifkan izin yang diperlukan.
• Informasi yang lebih baik bagi pengguna: Ekstensi dapat menjelaskan alasan diperlukannya izin tertentu saat pengguna mengaktifkan fitur yang relevan.
• Upgrade yang lebih mudah: Saat Anda mengupgrade ekstensi, Chrome tidak akan menonaktifkannya untuk pengguna jika upgrade menambahkan izin opsional, bukan yang diperlukan.

Langkah 2: Mendeklarasikan izin opsional dalam manifes

Deklarasikan izin opsional di manifes ekstensi dengan kunci optional_permissions, menggunakan format yang sama dengan kolom izin:

{
  "name": "My extension",
  ...
  "optional_permissions": ["tabs"],
  "optional_host_permissions": ["https://www.google.com/"],
  ...
}

Jika Anda ingin meminta host yang hanya Anda temukan saat runtime, sertakan "https://*/*" di kolom optional_host_permissions ekstensi Anda. Hal ini memungkinkan Anda menentukan origin apa pun di "Permissions.origins" selama memiliki skema yang cocok.

Izin yang tidak dapat ditetapkan sebagai opsional

Sebagian besar izin ekstensi Chrome dapat ditetapkan sebagai opsional, dengan pengecualian berikut.

Lihat Mendeklarasikan Izin untuk mengetahui informasi lebih lanjut tentang izin yang tersedia dan peringatannya.

Langkah 3: Minta izin opsional

Minta izin dari dalam gestur pengguna menggunakan permissions.request():

document.querySelector('#my-button').addEventListener('click', (event) => {
  // Permissions must be requested from inside a user gesture, like a button's
  // click handler.
  chrome.permissions.request({
    permissions: ['tabs'],
    origins: ['https://www.google.com/']
  }, (granted) => {
    // The callback argument will be true if the user granted the permissions.
    if (granted) {
      doSomething();
    } else {
      doSomethingElse();
    }
  });
});

Chrome akan meminta pengguna jika menambahkan izin akan menghasilkan pesan peringatan yang berbeda dari yang telah dilihat dan diterima pengguna. Misalnya, kode sebelumnya mungkin menghasilkan perintah seperti ini:

Langkah 4: Periksa izin ekstensi saat ini

Untuk memeriksa apakah ekstensi Anda memiliki izin atau kumpulan izin tertentu, gunakan permission.contains():

chrome.permissions.contains({
  permissions: ['tabs'],
  origins: ['https://www.google.com/']
}, (result) => {
  if (result) {
    // The extension has the permissions.
  } else {
    // The extension doesn't have the permissions.
  }
});

Langkah 5: Hapus izin

Sebaiknya Anda menghapus izin saat tidak lagi memerlukannya. Setelah izin dihapus, memanggil permissions.request() biasanya akan menambahkan kembali izin tanpa meminta izin pengguna.

chrome.permissions.remove({
  permissions: ['tabs'],
  origins: ['https://www.google.com/']
}, (removed) => {
  if (removed) {
    // The permissions have been removed.
  } else {
    // The permissions have not been removed (e.g., you tried to remove
    // required permissions).
  }
});

chrome.permissions.contains(
  permissions: Permissions,
  callback?: function,
)

chrome.permissions.getAll(
  callback?: function,
)

chrome.permissions.remove(
  permissions: Permissions,
  callback?: function,
)

chrome.permissions.request(
  permissions: Permissions,
  callback?: function,
)

chrome.permissions.onAdded.addListener(
  callback: function,
)

chrome.permissions.onRemoved.addListener(
  callback: function,
)