browser.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 sehingga pengguna dapat mencoba ekstensi tanpa risiko. Dengan begitu, pengguna dapat menentukan jumlah akses yang ingin mereka berikan dan fitur yang ingin mereka aktifkan.

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

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

Menerapkan izin opsional

Langkah 1: Tentukan izin mana yang diperlukan dan mana yang opsional

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

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

Keuntungan izin yang diperlukan:

• Lebih sedikit dialog: 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 untuk pengguna: Ekstensi dapat menjelaskan alasan perlunya 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 izin 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 permissions:

{
  "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. Dengan begitu, Anda dapat menentukan asal mana pun di "Permissions.origins" selama memiliki skema yang cocok.

Izin yang tidak dapat ditentukan sebagai opsional

Sebagian besar izin ekstensi Chrome dapat ditentukan 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.
  browser.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 penambahan izin menghasilkan pesan peringatan yang berbeda dengan yang telah dilihat dan disetujui pengguna. Misalnya, kode sebelumnya dapat menghasilkan perintah seperti ini:

Langkah 4: Periksa izin saat ini untuk ekstensi

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

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

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

browser.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.addHostAccessRequest(
  request: object,
): Promise<void>

chrome.permissions.contains(
  permissions: Permissions,
): Promise<boolean>

chrome.permissions.getAll(): Promise<Permissions>

chrome.permissions.remove(
  permissions: Permissions,
): Promise<boolean>

chrome.permissions.removeHostAccessRequest(
  request: object,
): Promise<void>

chrome.permissions.request(
  permissions: Permissions,
): Promise<boolean>

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

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