chrome.permissions

Deskripsi

Ringkasan

Peringatan izin ada untuk menjelaskan kemampuan yang diberikan oleh API, tetapi beberapa peringatan ini mungkin tidak jelas. Izin API memungkinkan developer menjelaskan peringatan izin dan memperkenalkan fitur baru secara bertahap yang memberi pengguna pengenalan ekstensi yang 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 adalah menampilkan sasaran pengguna hari ini. Fitur ini hanya memerlukan izin penyimpanan, yang tidak mencakup peringatan. Ekstensi ini memiliki fitur tambahan yang dapat diaktifkan oleh pengguna dengan mengklik tombol berikut:

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

Mengimplementasikan izin opsional

Langkah 1: Tentukan izin yang diperlukan dan yang bersifat opsional

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

• Gunakan izin yang diperlukan saat 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 sekali untuk menyetujui semua izin.
• Pengembangan yang lebih sederhana: Izin yang diperlukan dijamin selalu ada.

Keuntungan izin opsional:

• Keamanan yang lebih baik: Ekstensi berjalan dengan lebih sedikit izin karena pengguna hanya mengaktifkan izin yang dibutuhkan.
• Informasi yang lebih baik untuk pengguna: Ekstensi dapat menjelaskan mengapa ekstensi memerlukan izin tertentu saat pengguna mengaktifkan fitur yang relevan.
• Upgrade yang lebih mudah: Saat Anda mengupgrade ekstensi, Chrome tidak akan menonaktifkannya untuk pengguna jika upgrade akan menambahkan izin opsional, bukannya izin yang diwajibkan.

Langkah 2: Deklarasikan 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 ingin meminta host yang hanya Anda temukan saat runtime, sertakan "https://*/*" dalam kolom optional_host_permissions ekstensi Anda. Izin ini memungkinkan Anda menentukan origin apa pun di Permissions.origins selama memiliki kecocokan skema baru.

Izin yang tidak dapat ditetapkan sebagai opsional

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

Lihat Mendeklarasikan Izin dan Peringatkan Pengguna untuk informasi lebih lanjut tentang izin dan peringatan mereka.

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 memberi tahu pengguna jika menambahkan izin akan menghasilkan pesan peringatan yang berbeda dengan yang telah dilihat dan disetujui pengguna. Misalnya, kode sebelumnya mungkin menghasilkan perintah seperti ini:

Langkah 4: Periksa izin ekstensi saat ini

Untuk memeriksa apakah ekstensi Anda memiliki izin atau sekumpulan 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 hapus izin saat Anda tidak lagi memerlukannya. Setelah izin akses dihapus, memanggil permissions.request() biasanya akan menambahkan izin kembali tanpa meminta konfirmasi 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,
)