chrome.management

คำอธิบาย

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

สิทธิ์

management

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

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

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

ประเภท

ExtensionDisabledReason

Chrome 44 ขึ้นไป

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

ค่าแจกแจง

"ไม่ทราบ"

"permissions_increase"

ExtensionInfo

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

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

  • appLaunchUrl

    สตริง ไม่บังคับ

    URL การเปิดตัว (มีเฉพาะในแอป)

  • availableLaunchTypes

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

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

  • คำอธิบาย

    สตริง

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

  • disabledReason

    ExtensionDisabledReason ไม่บังคับ

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

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

    บูลีน

    เปิดใช้หรือปิดใช้ในขณะนี้

  • homepageUrl

    สตริง ไม่บังคับ

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

  • hostPermissions

    string[]

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

  • ไอคอน

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

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

  • id

    สตริง

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

  • installType

    ExtensionInstallType

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

  • isApp

    บูลีน

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

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

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

  • launchType

    LaunchType ไม่บังคับ

    ประเภทการเปิดแอป (มีเฉพาะในแอป)

  • mayDisable

    บูลีน

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

  • mayEnable

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

    Chrome 62 ขึ้นไป

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

  • ชื่อ

    สตริง

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

  • offlineEnabled

    บูลีน

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

  • optionsUrl

    สตริง

    URL ของหน้าตัวเลือกของสินค้า หากมี

  • สิทธิ์

    string[]

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

  • shortName

    สตริง

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

  • ประเภท

    ExtensionType

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

  • updateUrl

    สตริง ไม่บังคับ

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

  • เวอร์ชัน

    สตริง

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

  • versionName

    สตริง ไม่บังคับ

    Chrome 50 ขึ้นไป

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

ExtensionInstallType

Chrome 44 ขึ้นไป

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

ค่าแจกแจง

"admin"

"การพัฒนา"

"ปกติ"

"โหลดด้านข้าง"

"อื่นๆ"

ExtensionType

Chrome 44 ขึ้นไป

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

ค่าแจกแจง

"ส่วนขยาย"

"hosted_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

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

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

เมธอด

createAppShortcut()

chrome.management.createAppShortcut(
  id: string,
): Promise<void>

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

พารามิเตอร์

  • id

    สตริง

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

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

  • Promise<void>

    Chrome 88 ขึ้นไป 
chrome.management.generateAppForLink(
  url: string,
  title: string,
): Promise<ExtensionInfo>

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

พารามิเตอร์

  • URL

    สตริง

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

  • title

    สตริง

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

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

get()

chrome.management.get(
  id: string,
): Promise<ExtensionInfo>

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

พารามิเตอร์

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

getAll()

chrome.management.getAll(): Promise<ExtensionInfo[]>

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

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

getPermissionWarningsById()

chrome.management.getPermissionWarningsById(
  id: string,
): Promise<string[]>

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

พารามิเตอร์

  • id

    สตริง

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

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

  • Promise<string[]>

    Chrome 88 ขึ้นไป

getPermissionWarningsByManifest()

chrome.management.getPermissionWarningsByManifest(
  manifestStr: string,
): Promise<string[]>

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

พารามิเตอร์

  • manifestStr

    สตริง

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

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

  • Promise<string[]>

    Chrome 88 ขึ้นไป

getSelf()

chrome.management.getSelf(): Promise<ExtensionInfo>

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

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

installReplacementWebApp()

Chrome 77 ขึ้นไป 
chrome.management.installReplacementWebApp(): Promise<void>

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

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

  • Promise<void>

    Chrome 88 ขึ้นไป

launchApp()

chrome.management.launchApp(
  id: string,
): Promise<void>

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

พารามิเตอร์

  • id

    สตริง

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

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

  • Promise<void>

    Chrome 88 ขึ้นไป

setEnabled()

chrome.management.setEnabled(
  id: string,
  enabled: boolean,
): Promise<void>

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

พารามิเตอร์

  • id

    สตริง

    ซึ่งควรเป็นรหัสจากสินค้าของ management.ExtensionInfo

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

    บูลีน

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

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

  • Promise<void>

    Chrome 88 ขึ้นไป

setLaunchType()

chrome.management.setLaunchType(
  id: string,
  launchType: LaunchType,
): Promise<void>

ตั้งค่าประเภทการเปิดแอป

พารามิเตอร์

  • id

    สตริง

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

  • launchType

    LaunchType

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

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

  • Promise<void>

    Chrome 88 ขึ้นไป

uninstall()

chrome.management.uninstall(
  id: string,
  options?: UninstallOptions,
): Promise<void>

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

พารามิเตอร์

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

  • Promise<void>

    Chrome 88 ขึ้นไป

uninstallSelf()

chrome.management.uninstallSelf(
  options?: UninstallOptions,
): Promise<void>

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

พารามิเตอร์

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

  • Promise<void>

    Chrome 88 ขึ้นไป

กิจกรรม

onDisabled

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

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

พารามิเตอร์

  • callback

    ฟังก์ชัน

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

    (info: ExtensionInfo) => void

onEnabled

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

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

พารามิเตอร์

  • callback

    ฟังก์ชัน

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

    (info: ExtensionInfo) => void

onInstalled

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

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

พารามิเตอร์

  • callback

    ฟังก์ชัน

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

    (info: ExtensionInfo) => void

onUninstalled

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

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

พารามิเตอร์

  • callback

    ฟังก์ชัน

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

    (id: string) => void

    • id

      สตริง