chrome.management

คำอธิบาย

chrome.management API ให้วิธีจัดการแอปและส่วนขยายที่ติดตั้งไว้

สิทธิ์

management

คุณต้องประกาศ "การจัดการ" สิทธิ์ในไฟล์ Manifest ของส่วนขยายเพื่อใช้การจัดการ API เช่น

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

management.getPermissionWarningsByManifest(), management.uninstallSelf() และ management.getSelf() ไม่ต้องใช้สิทธิ์การจัดการ

ประเภท

ExtensionDisabledReason

Chrome 44 ขึ้นไป

เหตุผลที่ปิดใช้รายการ

ค่าแจกแจง

"ไม่ทราบ"

"permissions_increase"

ExtensionInfo

ข้อมูลเกี่ยวกับส่วนขยาย แอป หรือธีมที่ติดตั้ง

พร็อพเพอร์ตี้

• appLaunchUrl

  string ไม่บังคับ

  URL เปิดใช้งาน (แสดงสำหรับแอปเท่านั้น)

• availableLaunchTypes

  LaunchType[] ไม่บังคับ

  ประเภทการเปิดตัวที่ใช้ได้ในปัจจุบัน (ปรากฏสำหรับแอปเท่านั้น)

• คำอธิบาย

  สตริง

  คำอธิบายของส่วนขยาย แอป หรือธีมนี้

• disabledReason

  ExtensionDisabledReason ไม่บังคับ

  เหตุผลที่ปิดใช้รายการ

• เปิดใช้อยู่

  boolean

  ไม่ว่าจะเปิดหรือปิดใช้งานอยู่ในขณะนี้

• homepageUrl

  string ไม่บังคับ

  URL หน้าแรกของส่วนขยาย แอป หรือธีมนี้

• hostPermissions

  สตริง[]

  แสดงรายการสิทธิ์ตามโฮสต์

• ไอคอน

  IconInfo[] ไม่บังคับ

  รายการข้อมูลไอคอน โปรดทราบว่านี่เป็นเพียงสิ่งที่ประกาศไว้ในไฟล์ Manifest และรูปภาพจริงใน URL นั้นอาจมีขนาดใหญ่กว่าหรือเล็กกว่าที่ประกาศ ดังนั้นคุณอาจลองใช้แอตทริบิวต์ความกว้างและความสูงที่ชัดแจ้งในแท็ก img ที่อ้างอิงรูปภาพเหล่านี้ ดูรายละเอียดเพิ่มเติมได้ในเอกสารประกอบไฟล์ Manifest เกี่ยวกับไอคอน

• id

  สตริง

  ตัวระบุที่ไม่ซ้ำกันของส่วนขยาย

• installType

  ExtensionInstallType

  วิธีติดตั้งส่วนขยาย

• isApp

  boolean

  เลิกใช้งานแล้ว

  โปรดใช้ management.ExtensionInfo.type

  เป็นจริงหากเป็นแอป

• launchType

  LaunchType ไม่บังคับ

  ประเภทการเปิดแอป (ปรากฏสำหรับแอปเท่านั้น)

• mayDisable

  boolean

  ผู้ใช้สามารถปิดใช้หรือถอนการติดตั้งส่วนขยายนี้ได้หรือไม่

• mayEnable

  บูลีน ไม่บังคับ

  Chrome 62 ขึ้นไป

  ผู้ใช้จะเปิดใช้ส่วนขยายนี้ได้หรือไม่ การดำเนินการนี้จะแสดงผลสำหรับส่วนขยายที่ไม่ได้เปิดใช้เท่านั้น

• ชื่อ

  สตริง

  ชื่อของส่วนขยาย แอป หรือธีมนี้

• offlineEnabled

  boolean

  ส่วนขยาย แอป หรือธีมประกาศว่ารองรับการใช้งานแบบออฟไลน์หรือไม่

• optionsUrl

  สตริง

  URL สำหรับหน้าตัวเลือกของรายการ หากมี

• สิทธิ์

  สตริง[]

  แสดงรายการสิทธิ์ตาม API

• ชื่อย่อ

  สตริง

  ชื่อสั้นๆ ของส่วนขยาย แอป หรือธีมนี้

• ประเภท

  ExtensionType

  ประเภทของส่วนขยาย แอป หรือธีมนี้

• updateUrl

  string ไม่บังคับ

  URL อัปเดตของส่วนขยาย แอป หรือธีมนี้

• เวอร์ชัน

  สตริง

  เวอร์ชันของส่วนขยาย แอป หรือธีมนี้

• versionName

  string ไม่บังคับ

  Chrome 50 ขึ้นไป

  ชื่อเวอร์ชันของส่วนขยาย แอป หรือธีมนี้ หากไฟล์ Manifest ระบุไว้

ExtensionInstallType

Chrome 44 ขึ้นไป

วิธีติดตั้งส่วนขยาย หนึ่งใน admin: ส่วนขยายได้รับการติดตั้งเนื่องจากนโยบายการดูแลระบบ development: โหลดส่วนขยายซึ่งคลายการแพคข้อมูลในโหมดนักพัฒนาซอฟต์แวร์ normal: ส่วนขยายได้รับการติดตั้งตามปกติผ่านไฟล์ .crx sideload: ส่วนขยายได้รับการติดตั้งโดยซอฟต์แวร์อื่นในเครื่อง other: ส่วนขยายได้รับการติดตั้งด้วยวิธีอื่น

ค่าแจกแจง

"ผู้ดูแลระบบ"

"การพัฒนา"

"ปกติ"

"ไซด์โหลด"

"อื่นๆ"

ExtensionType

Chrome 44 ขึ้นไป

ประเภทของส่วนขยาย แอป หรือธีมนี้

ค่าแจกแจง

"ส่วนขยาย"

"Host_app"

"packaged_app"

"legacy_packaged_app"

"ธีม"

"login_screen_extension"

IconInfo

ข้อมูลเกี่ยวกับไอคอนที่เป็นของส่วนขยาย แอป หรือธีม

พร็อพเพอร์ตี้

• ขนาด

  ตัวเลข

  ตัวเลขที่แสดงถึงความกว้างและความสูงของไอคอน ค่าที่เป็นไปได้รวมถึง (แต่ไม่จํากัดเพียง) 128, 48, 24 และ 16

• URL

  สตริง

  URL ของรูปภาพไอคอนนี้ หากต้องการแสดงไอคอนในเวอร์ชันโทนสีเทา (เช่น เพื่อระบุว่ามีการปิดใช้ส่วนขยาย) ให้ใส่ ?grayscale=true ต่อท้าย URL

LaunchType

ประเภทการเปิดใช้งานแอปที่เป็นไปได้ทั้งหมดมีดังต่อไปนี้

ค่าแจกแจง

"OPEN_AS_REGULAR_TAB"

"OPEN_AS_PINNED_TAB"

"OPEN_AS_WINDOW"

"OPEN_FULL_SCREEN"

UninstallOptions

Chrome เวอร์ชัน 88 ขึ้นไป

ตัวเลือกสำหรับวิธีจัดการการถอนการติดตั้งส่วนขยาย

พร็อพเพอร์ตี้

• showConfirmDialog

  บูลีน ไม่บังคับ

  กล่องโต้ตอบยืนยันการถอนการติดตั้งควรแจ้งให้ผู้ใช้ทราบหรือไม่ ค่าเริ่มต้นคือ "เท็จ" สำหรับการถอนการติดตั้งด้วยตนเอง หากส่วนขยายถอนการติดตั้งส่วนขยายอื่น ระบบจะไม่สนใจพารามิเตอร์นี้และกล่องโต้ตอบจะแสดงเสมอ

เมธอด

createAppShortcut()

สัญญา

chrome.management.createAppShortcut(
  id: string,
  callback?: function,
)

แสดงตัวเลือกในการสร้างทางลัดสำหรับแอป บน Mac สามารถสร้างได้เฉพาะทางลัดแอปแพ็กเกจเท่านั้น

พารามิเตอร์

• id

  สตริง

  ควรเป็นรหัสจากรายการแอปของ management.ExtensionInfo

• Callback

  ไม่บังคับ

  พารามิเตอร์ callback มีลักษณะดังนี้

  () => void

การคืนสินค้า

• คำมั่นสัญญา<โมฆะ>

  Chrome เวอร์ชัน 88 ขึ้นไป

  รองรับคำสัญญาในไฟล์ Manifest V3 ขึ้นไป แต่จะมี Callback สำหรับ ความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 อย่างในการเรียกใช้ฟังก์ชันเดียวกันได้ จะมีการแก้ไขด้วยประเภทเดียวกันที่ส่งไปยัง Callback

generateAppForLink()

สัญญา

chrome.management.generateAppForLink(
  url: string,
  title: string,
  callback?: function,
)

สร้างแอปสำหรับ URL แสดงแอปบุ๊กมาร์กที่สร้างขึ้น

พารามิเตอร์

• URL

  สตริง

  URL ของหน้าเว็บ รูปแบบของ URL ต้องเป็น "http" เท่านั้น หรือ "https"

• title

  สตริง

  ชื่อของแอปที่สร้างขึ้น

• Callback

  ไม่บังคับ

  พารามิเตอร์ callback มีลักษณะดังนี้

  (result: ExtensionInfo) => void

  • ผลลัพธ์

    ExtensionInfo

การคืนสินค้า

• Promise&lt;ExtensionInfo&gt;

  Chrome เวอร์ชัน 88 ขึ้นไป

  รองรับคำสัญญาในไฟล์ Manifest V3 ขึ้นไป แต่จะมี Callback สำหรับ ความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 อย่างในการเรียกใช้ฟังก์ชันเดียวกันได้ จะมีการแก้ไขด้วยประเภทเดียวกันที่ส่งไปยัง Callback

get()

สัญญา

chrome.management.get(
  id: string,
  callback?: function,
)

แสดงผลข้อมูลเกี่ยวกับส่วนขยาย แอป หรือธีมที่ติดตั้งซึ่งมีรหัสที่ระบุ

พารามิเตอร์

• id

  สตริง

  รหัสจากรายการของ management.ExtensionInfo

• Callback

  ไม่บังคับ

  พารามิเตอร์ callback มีลักษณะดังนี้

  (result: ExtensionInfo) => void

  • ผลลัพธ์

    ExtensionInfo

การคืนสินค้า

• Promise&lt;ExtensionInfo&gt;

  Chrome เวอร์ชัน 88 ขึ้นไป

  รองรับคำสัญญาในไฟล์ Manifest V3 ขึ้นไป แต่จะมี Callback สำหรับ ความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 อย่างในการเรียกใช้ฟังก์ชันเดียวกันได้ จะมีการแก้ไขด้วยประเภทเดียวกันที่ส่งไปยัง Callback

getAll()

สัญญา

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

แสดงรายการข้อมูลเกี่ยวกับส่วนขยายและแอปที่ติดตั้งไว้

พารามิเตอร์

• Callback

  ไม่บังคับ

  พารามิเตอร์ callback มีลักษณะดังนี้

  (result: ExtensionInfo[]) => void

  • ผลลัพธ์

    ExtensionInfo[]

การคืนสินค้า

• Promise&lt;ExtensionInfo[]&gt;

  Chrome เวอร์ชัน 88 ขึ้นไป

  รองรับคำสัญญาในไฟล์ Manifest V3 ขึ้นไป แต่จะมี Callback สำหรับ ความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 อย่างในการเรียกใช้ฟังก์ชันเดียวกันได้ จะมีการแก้ไขด้วยประเภทเดียวกันที่ส่งไปยัง Callback

getPermissionWarningsById()

สัญญา

chrome.management.getPermissionWarningsById(
  id: string,
  callback?: function,
)

แสดงผลรายการคำเตือนเกี่ยวกับสิทธิ์สำหรับรหัสส่วนขยายที่ระบุ

พารามิเตอร์

• id

  สตริง

  รหัสของส่วนขยายที่ติดตั้งแล้ว

• Callback

  ไม่บังคับ

  พารามิเตอร์ callback มีลักษณะดังนี้

  (permissionWarnings: string[]) => void

  • permissionWarnings

    สตริง[]

การคืนสินค้า

• Promise&lt;string[]&gt;

  Chrome เวอร์ชัน 88 ขึ้นไป

  รองรับคำสัญญาในไฟล์ Manifest V3 ขึ้นไป แต่จะมี Callback สำหรับ ความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 อย่างในการเรียกใช้ฟังก์ชันเดียวกันได้ จะมีการแก้ไขด้วยประเภทเดียวกันที่ส่งไปยัง Callback

getPermissionWarningsByManifest()

สัญญา

chrome.management.getPermissionWarningsByManifest(
  manifestStr: string,
  callback?: function,
)

แสดงผลรายการคำเตือนเกี่ยวกับสิทธิ์สำหรับสตริงไฟล์ Manifest ของส่วนขยายที่ระบุ หมายเหตุ: ใช้ฟังก์ชันนี้ได้โดยไม่ต้องขอ "การจัดการ" ในไฟล์ Manifest

พารามิเตอร์

• manifestStr

  สตริง

  สตริง JSON ของไฟล์ Manifest ของส่วนขยาย

• Callback

  ไม่บังคับ

  พารามิเตอร์ callback มีลักษณะดังนี้

  (permissionWarnings: string[]) => void

  • permissionWarnings

    สตริง[]

การคืนสินค้า

• Promise&lt;string[]&gt;

  Chrome เวอร์ชัน 88 ขึ้นไป

  รองรับคำสัญญาในไฟล์ Manifest V3 ขึ้นไป แต่จะมี Callback สำหรับ ความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 อย่างในการเรียกใช้ฟังก์ชันเดียวกันได้ จะมีการแก้ไขด้วยประเภทเดียวกันที่ส่งไปยัง Callback

getSelf()

สัญญา

chrome.management.getSelf(
  callback?: function,
)

แสดงผลข้อมูลเกี่ยวกับส่วนขยายการโทร แอป หรือธีม หมายเหตุ: ใช้ฟังก์ชันนี้ได้โดยไม่ต้องขอ "การจัดการ" ในไฟล์ Manifest

พารามิเตอร์

• Callback

  ไม่บังคับ

  พารามิเตอร์ callback มีลักษณะดังนี้

  (result: ExtensionInfo) => void

  • ผลลัพธ์

    ExtensionInfo

การคืนสินค้า

• Promise&lt;ExtensionInfo&gt;

  Chrome เวอร์ชัน 88 ขึ้นไป

  รองรับคำสัญญาในไฟล์ Manifest V3 ขึ้นไป แต่จะมี Callback สำหรับ ความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 อย่างในการเรียกใช้ฟังก์ชันเดียวกันได้ จะมีการแก้ไขด้วยประเภทเดียวกันที่ส่งไปยัง Callback

installReplacementWebApp()

สัญญา Chrome 77 ขึ้นไป

chrome.management.installReplacementWebApp(
  callback?: function,
)

เปิด Replace_web_app ที่ระบุในไฟล์ Manifest แจ้งให้ผู้ใช้ติดตั้ง หากยังไม่ได้ติดตั้ง

พารามิเตอร์

• Callback

  ไม่บังคับ

  พารามิเตอร์ callback มีลักษณะดังนี้

  () => void

การคืนสินค้า

• คำมั่นสัญญา<โมฆะ>

  Chrome เวอร์ชัน 88 ขึ้นไป

  รองรับคำสัญญาในไฟล์ Manifest V3 ขึ้นไป แต่จะมี Callback สำหรับ ความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 อย่างในการเรียกใช้ฟังก์ชันเดียวกันได้ จะมีการแก้ไขด้วยประเภทเดียวกันที่ส่งไปยัง Callback

launchApp()

สัญญา

chrome.management.launchApp(
  id: string,
  callback?: function,
)

เปิดแอปพลิเคชัน

พารามิเตอร์

• id

  สตริง

  รหัสส่วนขยายของแอปพลิเคชัน

• Callback

  ไม่บังคับ

  พารามิเตอร์ callback มีลักษณะดังนี้

  () => void

การคืนสินค้า

• คำมั่นสัญญา<โมฆะ>

  Chrome เวอร์ชัน 88 ขึ้นไป

  รองรับคำสัญญาในไฟล์ Manifest V3 ขึ้นไป แต่จะมี Callback สำหรับ ความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 อย่างในการเรียกใช้ฟังก์ชันเดียวกันได้ จะมีการแก้ไขด้วยประเภทเดียวกันที่ส่งไปยัง Callback

setEnabled()

สัญญา

chrome.management.setEnabled(
  id: string,
  enabled: boolean,
  callback?: function,
)

เปิดหรือปิดใช้แอปหรือส่วนขยาย ในกรณีส่วนใหญ่ คุณต้องเรียกใช้ฟังก์ชันนี้ในบริบทของท่าทางสัมผัสของผู้ใช้ (เช่น เครื่องจัดการ onclick สำหรับปุ่ม) และอาจแสดง UI การยืนยันเนทีฟแก่ผู้ใช้เพื่อช่วยป้องกันการละเมิด

พารามิเตอร์

• id

  สตริง

  ควรเป็นรหัสจากรายการ management.ExtensionInfo

• เปิดใช้อยู่

  boolean

  ควรเปิดหรือปิดใช้รายการนี้

• Callback

  ไม่บังคับ

  พารามิเตอร์ callback มีลักษณะดังนี้

  () => void

การคืนสินค้า

• คำมั่นสัญญา<โมฆะ>

  Chrome เวอร์ชัน 88 ขึ้นไป

  รองรับคำสัญญาในไฟล์ Manifest V3 ขึ้นไป แต่จะมี Callback สำหรับ ความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 อย่างในการเรียกใช้ฟังก์ชันเดียวกันได้ จะมีการแก้ไขด้วยประเภทเดียวกันที่ส่งไปยัง Callback

setLaunchType()

สัญญา

chrome.management.setLaunchType(
  id: string,
  launchType: LaunchType,
  callback?: function,
)

กำหนดประเภทการเปิดใช้งานของแอป

พารามิเตอร์

• id

  สตริง

  ควรเป็นรหัสจากรายการแอปของ management.ExtensionInfo

• launchType

  LaunchType

  ประเภทการเปิดตัวเป้าหมาย โปรดตรวจสอบและตรวจสอบว่าประเภทการเปิดตัวนี้อยู่ใน ExtensionInfo.availableLaunchTypes เสมอ เนื่องจากประเภทการเปิดตัวที่ใช้ได้จะแตกต่างกันไปตามแพลตฟอร์มและการกำหนดค่าต่างๆ

• Callback

  ไม่บังคับ

  พารามิเตอร์ callback มีลักษณะดังนี้

  () => void

การคืนสินค้า

• คำมั่นสัญญา<โมฆะ>

  Chrome เวอร์ชัน 88 ขึ้นไป

  รองรับคำสัญญาในไฟล์ Manifest V3 ขึ้นไป แต่จะมี Callback สำหรับ ความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 อย่างในการเรียกใช้ฟังก์ชันเดียวกันได้ จะมีการแก้ไขด้วยประเภทเดียวกันที่ส่งไปยัง Callback

uninstall()

สัญญา

chrome.management.uninstall(
  id: string,
  options?: UninstallOptions,
  callback?: function,
)

ถอนการติดตั้งแอปหรือส่วนขยายที่ติดตั้งอยู่ในปัจจุบัน หมายเหตุ: ฟังก์ชันนี้ใช้งานไม่ได้ในสภาพแวดล้อมที่มีการจัดการเมื่อผู้ใช้ไม่ได้รับอนุญาตให้ถอนการติดตั้งส่วนขยาย/แอปที่ระบุ หากถอนการติดตั้งไม่สำเร็จ (เช่น ผู้ใช้ยกเลิกกล่องโต้ตอบ) ระบบจะปฏิเสธสัญญาหรือจะมีการเรียกใช้ Callback พร้อมกับตั้งค่า runtime.lastError

พารามิเตอร์

• id

  สตริง

  ควรเป็นรหัสจากรายการ management.ExtensionInfo

• ตัวเลือก

  UninstallOptions ไม่บังคับ

• Callback

  ไม่บังคับ

  พารามิเตอร์ callback มีลักษณะดังนี้

  () => void

การคืนสินค้า

• คำมั่นสัญญา<โมฆะ>

  Chrome เวอร์ชัน 88 ขึ้นไป

  รองรับคำสัญญาในไฟล์ Manifest V3 ขึ้นไป แต่จะมี Callback สำหรับ ความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 อย่างในการเรียกใช้ฟังก์ชันเดียวกันได้ จะมีการแก้ไขด้วยประเภทเดียวกันที่ส่งไปยัง Callback

uninstallSelf()

สัญญา

chrome.management.uninstallSelf(
  options?: UninstallOptions,
  callback?: function,
)

ถอนการติดตั้งส่วนขยายการโทร หมายเหตุ: ใช้ฟังก์ชันนี้ได้โดยไม่ต้องขอ "การจัดการ" ในไฟล์ Manifest ฟังก์ชันนี้ใช้งานไม่ได้ในสภาพแวดล้อมที่มีการจัดการเมื่อผู้ใช้ไม่ได้รับอนุญาตให้ถอนการติดตั้งส่วนขยาย/แอปที่ระบุ

พารามิเตอร์

• ตัวเลือก

  UninstallOptions ไม่บังคับ

• Callback

  ไม่บังคับ

  พารามิเตอร์ callback มีลักษณะดังนี้

  () => void

การคืนสินค้า

• คำมั่นสัญญา<โมฆะ>

  Chrome เวอร์ชัน 88 ขึ้นไป

  รองรับคำสัญญาในไฟล์ Manifest V3 ขึ้นไป แต่จะมี Callback สำหรับ ความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 อย่างในการเรียกใช้ฟังก์ชันเดียวกันได้ จะมีการแก้ไขด้วยประเภทเดียวกันที่ส่งไปยัง Callback

กิจกรรม

onDisabled

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

เริ่มทำงานเมื่อมีการปิดใช้แอปหรือส่วนขยาย

พารามิเตอร์

• Callback

  ฟังก์ชัน

  พารามิเตอร์ callback มีลักษณะดังนี้

  (info: ExtensionInfo) => void

  • ข้อมูล

    ExtensionInfo

onEnabled

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

เริ่มทำงานเมื่อมีการเปิดใช้แอปหรือส่วนขยาย

พารามิเตอร์

• Callback

  ฟังก์ชัน

  พารามิเตอร์ callback มีลักษณะดังนี้

  (info: ExtensionInfo) => void

  • ข้อมูล

    ExtensionInfo

onInstalled

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

เริ่มทำงานเมื่อมีการติดตั้งแอปหรือส่วนขยายแล้ว

พารามิเตอร์

• Callback

  ฟังก์ชัน

  พารามิเตอร์ callback มีลักษณะดังนี้

  (info: ExtensionInfo) => void

  • ข้อมูล

    ExtensionInfo

onUninstalled

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

เริ่มทำงานเมื่อถอนการติดตั้งแอปหรือส่วนขยาย

พารามิเตอร์

• Callback

  ฟังก์ชัน

  พารามิเตอร์ callback มีลักษณะดังนี้

  (id: string) => void

  • id

    สตริง