chrome.permissions

Mô tả

Khái niệm và cách sử dụng

Cảnh báo về quyền tồn tại để mô tả các chức năng do API cấp, nhưng một số cảnh báo trong số này có thể không rõ ràng. Permissions API cho phép nhà phát triển giải thích cảnh báo về quyền và giới thiệu dần các tính năng mới để người dùng có thể làm quen với tiện ích mà không gặp rủi ro. Bằng cách này, người dùng có thể chỉ định mức độ truy cập mà họ sẵn sàng cấp và những tính năng mà họ muốn bật.

Ví dụ: chức năng cốt lõi của phần mở rộng quyền không bắt buộc đang ghi đè trang thẻ mới. Một tính năng đang hiển thị mục tiêu của người dùng trong ngày. Tính năng này chỉ yêu cầu quyền truy cập vào bộ nhớ và không đưa ra cảnh báo. Tiện ích này có một tính năng bổ sung mà người dùng có thể bật bằng cách nhấp vào nút sau:

Để hiển thị các trang web hàng đầu của người dùng, bạn cần có quyền topSites. Quyền này có cảnh báo sau.

Triển khai các quyền không bắt buộc

Bước 1: Quyết định những quyền cần thiết và những quyền không bắt buộc

Một tiện ích có thể khai báo cả quyền bắt buộc và quyền không bắt buộc. Nhìn chung, bạn nên:

• Sử dụng các quyền bắt buộc khi cần thiết cho chức năng cơ bản của tiện ích.
• Sử dụng các quyền không bắt buộc khi cần thiết cho các tính năng không bắt buộc trong tiện ích.

Ưu điểm của các quyền bắt buộc:

• Ít lời nhắc hơn: Tiện ích có thể nhắc người dùng một lần để chấp nhận tất cả các quyền.
• Quá trình phát triển đơn giản hơn: Các quyền cần thiết được đảm bảo sẽ có.

Ưu điểm của các quyền không bắt buộc:

• Tăng cường bảo mật: Tiện ích chạy với ít quyền hơn vì người dùng chỉ bật các quyền cần thiết.
• Thông tin tốt hơn cho người dùng: Tiện ích có thể giải thích lý do cần có một quyền cụ thể khi người dùng bật tính năng có liên quan.
• Dễ dàng nâng cấp hơn: Khi bạn nâng cấp tiện ích, Chrome sẽ không tắt tiện ích đó cho người dùng nếu bản nâng cấp thêm các quyền không bắt buộc thay vì các quyền bắt buộc.

Bước 2: Khai báo các quyền không bắt buộc trong tệp kê khai

Khai báo các quyền không bắt buộc trong tệp kê khai tiện ích bằng khoá optional_permissions, sử dụng định dạng giống như trường quyền:

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

Nếu bạn muốn yêu cầu các máy chủ lưu trữ mà bạn chỉ phát hiện được trong thời gian chạy, hãy thêm "https://*/*" vào trường optional_host_permissions của tiện ích. Điều này cho phép bạn chỉ định bất kỳ nguồn gốc nào trong "Permissions.origins" miễn là nguồn gốc đó có giao thức phù hợp.

Các quyền không được chỉ định là không bắt buộc

Bạn có thể chỉ định hầu hết các quyền đối với tiện ích Chrome là không bắt buộc, ngoại trừ các trường hợp ngoại lệ sau.

Xem phần Khai báo quyền để biết thêm thông tin về các quyền hiện có và cảnh báo về các quyền đó.

Bước 3: Yêu cầu cấp quyền không bắt buộc

Yêu cầu cấp quyền trong một cử chỉ của người dùng bằng 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 sẽ nhắc người dùng nếu việc thêm các quyền này dẫn đến thông báo cảnh báo khác với thông báo mà người dùng đã thấy và chấp nhận. Ví dụ: mã trước đó có thể dẫn đến lời nhắc như sau:

Bước 4: Kiểm tra các quyền hiện tại của tiện ích

Để kiểm tra xem tiện ích của bạn có một quyền hoặc tập hợp quyền cụ thể hay không, hãy sử dụng 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.
  }
});

Bước 5: Xoá quyền

Bạn nên xoá các quyền khi không cần đến nữa. Sau khi một quyền bị xoá, lệnh gọi permissions.request() thường sẽ thêm lại quyền đó mà không cần nhắc người dùng.

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.addHostAccessRequest(
  request: object,
  callback?: function,
)

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

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

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

chrome.permissions.removeHostAccessRequest(
  request: object,
  callback?: function,
)

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

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

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