chrome.management

Mô tả

API chrome.management cung cấp các cách quản lý các ứng dụng và tiện ích đã cài đặt.

Quyền

management

Tệp kê khai

Bạn phải khai báo quyền "quản lý" quyền sử dụng tính năng quản lý trong tệp kê khai tiện ích API. Ví dụ:

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

management.getPermissionWarningsByManifest, management.uninstallSelf và management.getSelf không yêu cầu quyền quản lý.

Loại

ExtensionDisabledReason

Chrome 44 trở lên

Lý do mục bị vô hiệu hoá.

Enum

"không xác định"

"permissions_increase"

ExtensionInfo

Thông tin về một tiện ích, ứng dụng hoặc giao diện đã cài đặt.

Thuộc tính

  • appLaunchUrl

    chuỗi không bắt buộc

    URL chạy (chỉ dành cho ứng dụng).

  • availableLaunchTypes

    LaunchType[] không bắt buộc

    Các hình thức phát hành hiện có (chỉ dành cho ứng dụng).

  • description

    string

    Mô tả của tiện ích, ứng dụng hoặc giao diện này.

  • disabledReason

    ExtensionDisabledReason không bắt buộc

    Lý do mục bị vô hiệu hoá.

  • đang bật

    boolean

    Trạng thái hiện tại đang bật hay đang tắt.

  • homepageUrl

    chuỗi không bắt buộc

    URL của trang chủ của tiện ích, ứng dụng hoặc giao diện này.

  • hostPermissions

    chuỗi[]

    Trả về danh sách quyền dựa trên máy chủ lưu trữ.

  • biểu tượng

    IconInfo[] không bắt buộc

    Danh sách thông tin về biểu tượng. Lưu ý rằng điều này chỉ phản ánh những gì đã được khai báo trong tệp kê khai và hình ảnh thực tế tại url đó có thể lớn hơn hoặc nhỏ hơn những gì đã được khai báo, vì vậy bạn có thể cân nhắc sử dụng thuộc tính chiều rộng và chiều cao rõ ràng trên các thẻ img tham chiếu đến những hình ảnh này. Xem tài liệu tệp kê khai về biểu tượng để biết thêm chi tiết.

  • id

    string

    Giá trị nhận dạng duy nhất của tiện ích.

  • installType

    ExtensionInstallType

    Cách cài đặt tiện ích.

  • isApp

    boolean

    Không dùng nữa

    Vui lòng sử dụng management.ExtensionInfo.type.

    "True" nếu đây là ứng dụng.

  • launchType

    LaunchType không bắt buộc

    Kiểu khởi chạy ứng dụng (chỉ hiển thị với ứng dụng).

  • mayDisable

    boolean

    Người dùng có thể tắt hoặc gỡ cài đặt tiện ích này hay không.

  • mayEnable

    boolean không bắt buộc

    Chrome 62 trở lên

    Liệu người dùng có thể bật tiện ích này hay không. Giá trị này chỉ được trả về cho các tiện ích chưa được bật.

  • tên

    string

    Tên của tiện ích, ứng dụng hoặc giao diện này.

  • offlineEnabled

    boolean

    Liệu tiện ích, ứng dụng hoặc giao diện có khai báo rằng nó hỗ trợ chế độ ngoại tuyến hay không.

  • optionsUrl

    string

    URL cho trang lựa chọn của mặt hàng, nếu có.

  • quyền

    chuỗi[]

    Trả về danh sách quyền dựa trên API.

  • tên viết tắt

    string

    Phiên bản ngắn của tên của tiện ích, ứng dụng hoặc giao diện này.

  • loại

    ExtensionType

    Loại tiện ích, ứng dụng hoặc giao diện này.

  • updateUrl

    chuỗi không bắt buộc

    URL cập nhật của tiện ích, ứng dụng hoặc giao diện này.

  • version

    string

    Phiên bản của tiện ích, ứng dụng hoặc giao diện này.

  • versionName

    chuỗi không bắt buộc

    Chrome 50 trở lên

    Tên phiên bản của tiện ích, ứng dụng hoặc giao diện này nếu tệp kê khai chỉ định tên.

ExtensionInstallType

Chrome 44 trở lên

Cách cài đặt tiện ích. Một trong số admin: Tiện ích này đã được cài đặt do chính sách quản trị, development: Tiện ích này đã được tải và đã giải nén ở chế độ nhà phát triển, normal: Tiện ích này đã được cài đặt bình thường qua tệp .crx, sideload: Tiện ích này đã được phần mềm khác trên máy cài đặt, other: Tiện ích này đã được cài đặt bằng cách khác.

Enum

"quản trị viên"

"phát triển"

"normal" (bình thường)

"sideload"

"khác"

ExtensionType

Chrome 44 trở lên

Loại tiện ích, ứng dụng hoặc giao diện này.

Enum

"extension"

"host_app"

"packaged_app"

"legacy_packaged_app"

"theme"

"login_screen_extension"

IconInfo

Thông tin về một biểu tượng thuộc về một tiện ích, ứng dụng hoặc giao diện.

Thuộc tính

  • size

    số

    Số đại diện cho chiều rộng và chiều cao của biểu tượng. Giá trị có thể bao gồm (nhưng không giới hạn ở) 128, 48, 24 và 16.

  • url

    string

    URL của hình ảnh biểu tượng này. Để hiển thị phiên bản biểu tượng theo thang màu xám (ví dụ: để cho biết một tiện ích đã bị tắt), hãy thêm ?grayscale=true vào URL.

LaunchType

Đây là tất cả các kiểu chạy ứng dụng mà bạn có thể áp dụng.

Enum

"OPEN_AS_REGULAR_TAB"

"OPEN_AS_PINNED_TAB"

"OPEN_AS_WINDOW"

"OPEN_FULL_SCREEN"

UninstallOptions

Chrome 88 trở lên

Các tuỳ chọn về cách xử lý việc gỡ cài đặt tiện ích.

Thuộc tính

  • showConfirmDialog

    boolean không bắt buộc

    Hộp thoại xác nhận gỡ cài đặt có nhắc người dùng hay không. Giá trị mặc định là false khi tự gỡ cài đặt. Nếu một tiện ích gỡ cài đặt một tiện ích khác, thì tham số này sẽ bị bỏ qua và hộp thoại sẽ luôn hiển thị.

Phương thức

createAppShortcut()

Lời hứa 
chrome.management.createAppShortcut(
  id: string,
  callback?: function,
)

Hiện các tuỳ chọn để tạo lối tắt cho ứng dụng. Trên máy Mac, bạn chỉ có thể tạo các lối tắt ứng dụng đóng gói.

Tham số

  • id

    string

    Đây phải là mã nhận dạng của một mục ứng dụng của management.ExtensionInfo.

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    () => void

Giá trị trả về

  • Lời hứa<vô hiệu>

    Chrome 88 trở lên

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

Lời hứa 
chrome.management.generateAppForLink(
  url: string,
  title: string,
  callback?: function,
)

Tạo ứng dụng cho URL. Trả về ứng dụng dấu trang đã tạo.

Tham số

  • url

    string

    URL của một trang web. Lược đồ của URL chỉ có thể là "http" hoặc "https".

  • tiêu đề

    string

    Tiêu đề của ứng dụng đã tạo.

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    (result: ExtensionInfo) => void

Giá trị trả về

  • Promise&lt;ExtensionInfo&gt;

    Chrome 88 trở lên

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

get()

Lời hứa 
chrome.management.get(
  id: string,
  callback?: function,
)

Trả về thông tin về tiện ích, ứng dụng hoặc giao diện đã cài đặt có mã nhận dạng đã cho.

Tham số

Giá trị trả về

  • Promise&lt;ExtensionInfo&gt;

    Chrome 88 trở lên

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

getAll()

Lời hứa 
chrome.management.getAll(
  callback?: function,
)

Trả về danh sách thông tin về các ứng dụng và tiện ích đã cài đặt.

Tham số

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    (result: ExtensionInfo[]) => void

Giá trị trả về

  • Promise&lt;ExtensionInfo[]&gt;

    Chrome 88 trở lên

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

getPermissionWarningsById()

Lời hứa 
chrome.management.getPermissionWarningsById(
  id: string,
  callback?: function,
)

Trả về danh sách cảnh báo quyền cho mã tiện ích đã cho.

Tham số

  • id

    string

    Mã của một tiện ích đã được cài đặt.

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    (permissionWarnings: string[]) => void

    • permissionWarnings

      chuỗi[]

Giá trị trả về

  • Promise&lt;string[]&gt;

    Chrome 88 trở lên

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

getPermissionWarningsByManifest()

Lời hứa 
chrome.management.getPermissionWarningsByManifest(
  manifestStr: string,
  callback?: function,
)

Trả về danh sách cảnh báo quyền cho chuỗi tệp kê khai tiện ích nhất định. Lưu ý: Bạn có thể sử dụng hàm này mà không cần yêu cầu quyền "quản lý" quyền trong tệp kê khai.

Tham số

  • manifestStr

    string

    Chuỗi JSON của tệp kê khai tiện ích.

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    (permissionWarnings: string[]) => void

    • permissionWarnings

      chuỗi[]

Giá trị trả về

  • Promise&lt;string[]&gt;

    Chrome 88 trở lên

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

getSelf()

Lời hứa 
chrome.management.getSelf(
  callback?: function,
)

Trả về thông tin về tiện ích gọi, ứng dụng hoặc giao diện. Lưu ý: Bạn có thể sử dụng hàm này mà không cần yêu cầu quyền "quản lý" quyền trong tệp kê khai.

Tham số

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    (result: ExtensionInfo) => void

Giá trị trả về

  • Promise&lt;ExtensionInfo&gt;

    Chrome 88 trở lên

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

installReplacementWebApp()

Lời hứa Chrome 77 trở lên 
chrome.management.installReplacementWebApp(
  callback?: function,
)

Khởi chạy replace_web_app được chỉ định trong tệp kê khai. Nhắc người dùng cài đặt nếu họ chưa cài đặt.

Tham số

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    () => void

Giá trị trả về

  • Lời hứa<vô hiệu>

    Chrome 88 trở lên

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

launchApp()

Lời hứa 
chrome.management.launchApp(
  id: string,
  callback?: function,
)

Khởi chạy một ứng dụng.

Tham số

  • id

    string

    Mã tiện ích của ứng dụng.

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    () => void

Giá trị trả về

  • Lời hứa<vô hiệu>

    Chrome 88 trở lên

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

setEnabled()

Lời hứa 
chrome.management.setEnabled(
  id: string,
  enabled: boolean,
  callback?: function,
)

Bật hoặc tắt ứng dụng hoặc tiện ích. Trong hầu hết các trường hợp, hàm này phải được gọi trong ngữ cảnh cử chỉ của người dùng (ví dụ: trình xử lý nhấp cho một nút) và có thể hiển thị cho người dùng giao diện người dùng xác nhận gốc để ngăn chặn hành vi lạm dụng.

Tham số

  • id

    string

    Đây phải là mã nhận dạng của một mục của management.ExtensionInfo.

  • đang bật

    boolean

    Liệu bạn nên bật hay tắt mục này.

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    () => void

Giá trị trả về

  • Lời hứa<vô hiệu>

    Chrome 88 trở lên

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

setLaunchType()

Lời hứa 
chrome.management.setLaunchType(
  id: string,
  launchType: LaunchType,
  callback?: function,
)

Đặt kiểu chạy ứng dụng.

Tham số

  • id

    string

    Đây phải là mã nhận dạng của một mục ứng dụng của management.ExtensionInfo.

  • launchType

    LaunchType

    Loại hình ra mắt mục tiêu. Luôn kiểm tra và đảm bảo loại phiên bản phát hành này nằm trong ExtensionInfo.availableLaunchTypes, vì các loại phiên bản phát hành có sẵn sẽ khác nhau tuỳ theo nền tảng và cấu hình.

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    () => void

Giá trị trả về

  • Lời hứa<vô hiệu>

    Chrome 88 trở lên

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

uninstall()

Lời hứa 
chrome.management.uninstall(
  id: string,
  options?: UninstallOptions,
  callback?: function,
)

Gỡ cài đặt ứng dụng hoặc tiện ích hiện được cài đặt. Lưu ý: Chức năng này không hoạt động trong môi trường được quản lý khi người dùng không được phép gỡ cài đặt tiện ích/ứng dụng đã chỉ định. Nếu không gỡ cài đặt được (ví dụ: người dùng huỷ hộp thoại), thì lời hứa sẽ bị từ chối hoặc lệnh gọi lại sẽ được gọi khi đã đặt runtime.lastError.

Tham số

  • id

    string

    Đây phải là mã nhận dạng của một mục của management.ExtensionInfo.

  • tùy chọn

    UninstallOptions không bắt buộc

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    () => void

Giá trị trả về

  • Lời hứa<vô hiệu>

    Chrome 88 trở lên

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

uninstallSelf()

Lời hứa 
chrome.management.uninstallSelf(
  options?: UninstallOptions,
  callback?: function,
)

Gỡ cài đặt tiện ích gọi điện. Lưu ý: Bạn có thể sử dụng hàm này mà không cần yêu cầu quyền "quản lý" quyền trong tệp kê khai. Hàm này không hoạt động trong môi trường được quản lý khi người dùng không được phép gỡ cài đặt tiện ích/ứng dụng đã chỉ định.

Tham số

  • tùy chọn

    UninstallOptions không bắt buộc

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    () => void

Giá trị trả về

  • Lời hứa<vô hiệu>

    Chrome 88 trở lên

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

Sự kiện

onDisabled

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

Được kích hoạt khi ứng dụng hoặc tiện ích đã bị tắt.

Tham số

onEnabled

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

Được kích hoạt khi đã bật một ứng dụng hoặc tiện ích.

Tham số

onInstalled

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

Được kích hoạt khi đã cài đặt một ứng dụng hoặc tiện ích.

Tham số

onUninstalled

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

Được kích hoạt khi ứng dụng hoặc tiện ích đã bị gỡ cài đặt.

Tham số

  • số gọi lại

    hàm

    Tham số callback sẽ có dạng như sau: 

    (id: string) => void

    • id

      string