คำอธิบาย
chrome.management
API ให้วิธีจัดการรายการส่วนขยาย/แอปที่ติดตั้งและทำงานอยู่ ซึ่งมีประโยชน์อย่างยิ่งสำหรับส่วนขยายที่ลบล้างหน้าแท็บใหม่ในตัว
สิทธิ์
management
ไฟล์ Manifest
คุณต้องประกาศสิทธิ์ "การจัดการ" ในไฟล์ Manifest ของส่วนขยายเพื่อใช้ API การจัดการ เช่น
{
"name": "My extension",
...
"permissions": [
"management"
],
...
}
management.getPermissionWarningsByManifest
, management.uninstallSelf
และ management.getSelf
ไม่จำเป็นต้องใช้สิทธิ์การจัดการ
ประเภท
ExtensionDisabledReason
เหตุผลที่รายการถูกปิดใช้
ค่าแจกแจง
ExtensionInfo
ข้อมูลเกี่ยวกับส่วนขยาย แอป หรือธีมที่ติดตั้ง
พร็อพเพอร์ตี้
-
appLaunchUrl
string ไม่บังคับ
URL เปิดใช้งาน (แสดงสำหรับแอปเท่านั้น)
-
availableLaunchTypes
LaunchType[] ไม่บังคับ
ประเภทการเปิดตัวที่พร้อมใช้งานในปัจจุบัน (มีไว้สำหรับแอปเท่านั้น)
-
คำอธิบาย
string
คำอธิบายของส่วนขยาย แอป หรือธีมนี้
-
disabledReason
ExtensionDisabledReason ไม่บังคับ
เหตุผลที่รายการถูกปิดใช้
-
เปิดใช้อยู่
boolean
ไม่ว่าจะเปิดใช้งานหรือปิดใช้งานอยู่ในปัจจุบันก็ตาม
-
homepageUrl
string ไม่บังคับ
URL หน้าแรกของส่วนขยาย แอป หรือธีมนี้
-
hostPermissions
สตริง[]
แสดงผลรายการสิทธิ์ตามโฮสต์
-
ไอคอน
IconInfo[] ไม่บังคับ
รายการข้อมูลไอคอน โปรดทราบว่าข้อมูลนี้เพียงแค่แสดงถึงสิ่งที่ประกาศในไฟล์ Manifest และรูปภาพจริงที่ URL นั้นอาจมีขนาดใหญ่กว่าหรือเล็กกว่าที่ประกาศ คุณจึงอาจพิจารณาใช้แอตทริบิวต์ความกว้างและความสูงที่ชัดเจนในแท็ก img ที่อ้างอิงถึงรูปภาพเหล่านี้ โปรดดูรายละเอียดเพิ่มเติมในเอกสารประกอบของไฟล์ Manifest เกี่ยวกับไอคอน
-
id
string
ตัวระบุที่ไม่ซ้ำกันของส่วนขยาย
-
installType
วิธีติดตั้งส่วนขยาย
-
isApp
boolean
เลิกใช้งานแล้วโปรดใช้
management.ExtensionInfo.type
เป็นจริงหากเป็นแอป
-
launchType
LaunchType ไม่บังคับ
ประเภทการเปิดแอป (แสดงสำหรับแอปเท่านั้น)
-
mayDisable
boolean
ผู้ใช้สามารถปิดใช้งานหรือถอนการติดตั้งส่วนขยายนี้ได้หรือไม่
-
mayEnable
บูลีน ไม่บังคับ
Chrome 62 ขึ้นไปผู้ใช้สามารถเปิดใช้ส่วนขยายนี้ได้หรือไม่ ซึ่งจะแสดงเฉพาะสำหรับส่วนขยายที่ไม่ได้เปิดใช้
-
ชื่อ
string
ชื่อของส่วนขยาย แอป หรือธีมนี้
-
offlineEnabled
boolean
ส่วนขยาย แอป หรือธีมประกาศว่ารองรับการใช้งานแบบออฟไลน์หรือไม่
-
optionsUrl
string
URL สำหรับหน้าตัวเลือกของรายการ หากมี
-
สิทธิ์
สตริง[]
แสดงผลรายการสิทธิ์ที่ใช้ API
-
shortName
string
ชื่อสั้นๆ ของส่วนขยาย แอป หรือธีมนี้
-
ประเภท
ประเภทของส่วนขยาย แอป หรือธีมนี้
-
updateUrl
string ไม่บังคับ
URL อัปเดตของส่วนขยาย แอป หรือธีมนี้
-
เวอร์ชัน
string
เวอร์ชันของส่วนขยาย แอป หรือธีมนี้
-
versionName
string ไม่บังคับ
Chrome 50 ขึ้นไปชื่อเวอร์ชันของส่วนขยาย แอป หรือธีมนี้หากไฟล์ Manifest ระบุไว้
ExtensionInstallType
วิธีติดตั้งส่วนขยาย หนึ่งใน
admin
: ส่วนขยายได้รับการติดตั้งเนื่องจากนโยบายการดูแลระบบ
development
: ส่วนขยายโหลดขึ้นในโหมดนักพัฒนาซอฟต์แวร์
normal
: ส่วนขยายได้รับการติดตั้งตามปกติผ่านไฟล์ .crx,
sideload
: ส่วนขยายติดตั้งโดยซอฟต์แวร์อื่นในเครื่อง,
other
: ส่วนขยายติดตั้งด้วยวิธีการอื่น
ค่าแจกแจง
ExtensionType
ประเภทของส่วนขยาย แอป หรือธีมนี้
ค่าแจกแจง
"packaged_app"
"legacy_packaged_app"
"login_screen_extension"
IconInfo
ข้อมูลเกี่ยวกับไอคอนที่เป็นของส่วนขยาย แอป หรือธีม
พร็อพเพอร์ตี้
-
ขนาด
ตัวเลข
ตัวเลขที่แสดงถึงความกว้างและความสูงของไอคอน ค่าที่เป็นไปได้รวมถึง (แต่ไม่จำกัดเพียง) 128, 48, 24 และ 16
-
url
string
URL สำหรับรูปภาพไอคอนนี้ หากต้องการแสดงไอคอนเวอร์ชันโทนสีเทา (เพื่อระบุว่ามีการปิดใช้ส่วนขยาย เป็นต้น) ให้ใส่
?grayscale=true
ต่อท้าย URL
LaunchType
ที่กล่าวมาคือประเภทการเปิดแอปที่เป็นไปได้ทั้งหมด
ค่าแจกแจง
"OPEN_AS_REGULAR_TAB"
"OPEN_AS_PINNED_TAB"
"OPEN_AS_WINDOW"
"OPEN_FULL_SCREEN"
UninstallOptions
ตัวเลือกสำหรับวิธีจัดการกับการถอนการติดตั้งส่วนขยาย
พร็อพเพอร์ตี้
-
showConfirmDialog
บูลีน ไม่บังคับ
กล่องโต้ตอบยืนยันการถอนการติดตั้งควรแจ้งให้ผู้ใช้ทราบหรือไม่ ค่าเริ่มต้นเป็น "เท็จ" หากถอนการติดตั้งด้วยตนเอง หากส่วนขยายถอนการติดตั้งส่วนขยายอื่น ระบบจะไม่สนใจพารามิเตอร์นี้และกล่องโต้ตอบจะแสดงเสมอ
วิธีการ
createAppShortcut()
chrome.management.createAppShortcut(
id: string,
callback?: function,
)
แสดงตัวเลือกเพื่อสร้างทางลัดสำหรับแอป สำหรับ Mac คุณจะสร้างทางลัดของแอปแพ็กเกจได้เท่านั้น
พารามิเตอร์
-
id
string
ค่านี้ควรเป็นรหัสจากรายการแอปของ
management.ExtensionInfo
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
มีลักษณะดังนี้() => void
การคืนสินค้า
-
Promise<void>
Chrome เวอร์ชัน 88 ขึ้นไปPromiss รองรับเฉพาะไฟล์ Manifest V3 ขึ้นไป ส่วนแพลตฟอร์มอื่นๆ จะต้องใช้โค้ดเรียกกลับ
generateAppForLink()
chrome.management.generateAppForLink(
url: string,
title: string,
callback?: function,
)
สร้างแอปสำหรับ URL แสดงแอปบุ๊กมาร์กที่สร้างขึ้น
พารามิเตอร์
-
url
string
URL ของหน้าเว็บ รูปแบบของ URL เป็นได้เฉพาะ "http" หรือ "https" เท่านั้น
-
title
string
ชื่อแอปที่สร้างขึ้น
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
มีลักษณะดังนี้(result: ExtensionInfo) => void
-
ผลลัพธ์
-
การคืนสินค้า
-
Promise<ExtensionInfo>
Chrome เวอร์ชัน 88 ขึ้นไปPromiss รองรับเฉพาะไฟล์ Manifest V3 ขึ้นไป ส่วนแพลตฟอร์มอื่นๆ จะต้องใช้โค้ดเรียกกลับ
get()
chrome.management.get(
id: string,
callback?: function,
)
แสดงผลข้อมูลเกี่ยวกับส่วนขยาย แอป หรือธีมที่ติดตั้งซึ่งมีรหัสที่กำหนด
พารามิเตอร์
-
id
string
รหัสจากรายการของ
management.ExtensionInfo
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
มีลักษณะดังนี้(result: ExtensionInfo) => void
-
ผลลัพธ์
-
การคืนสินค้า
-
Promise<ExtensionInfo>
Chrome เวอร์ชัน 88 ขึ้นไปPromiss รองรับเฉพาะไฟล์ Manifest V3 ขึ้นไป ส่วนแพลตฟอร์มอื่นๆ จะต้องใช้โค้ดเรียกกลับ
getAll()
chrome.management.getAll(
callback?: function,
)
แสดงรายการข้อมูลเกี่ยวกับส่วนขยายและแอปที่ติดตั้งไว้
พารามิเตอร์
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
มีลักษณะดังนี้(result: ExtensionInfo[]) => void
-
ผลลัพธ์
-
การคืนสินค้า
-
Promise<ExtensionInfo[]>
Chrome เวอร์ชัน 88 ขึ้นไปPromiss รองรับเฉพาะไฟล์ Manifest V3 ขึ้นไป ส่วนแพลตฟอร์มอื่นๆ จะต้องใช้โค้ดเรียกกลับ
getPermissionWarningsById()
chrome.management.getPermissionWarningsById(
id: string,
callback?: function,
)
แสดงรายการคำเตือนเกี่ยวกับสิทธิ์สำหรับรหัสส่วนขยายที่ระบุ
พารามิเตอร์
-
id
string
รหัสของส่วนขยายที่ติดตั้งแล้ว
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
มีลักษณะดังนี้(permissionWarnings: string[]) => void
-
permissionWarnings
สตริง[]
-
การคืนสินค้า
-
คำสัญญา<string[]>
Chrome เวอร์ชัน 88 ขึ้นไปPromiss รองรับเฉพาะไฟล์ Manifest V3 ขึ้นไป ส่วนแพลตฟอร์มอื่นๆ จะต้องใช้โค้ดเรียกกลับ
getPermissionWarningsByManifest()
chrome.management.getPermissionWarningsByManifest(
manifestStr: string,
callback?: function,
)
แสดงรายการคำเตือนเกี่ยวกับสิทธิ์สำหรับสตริงไฟล์ Manifest ของส่วนขยายที่ระบุ หมายเหตุ: คุณใช้ฟังก์ชันนี้ได้โดยไม่ต้องขอสิทธิ์ "การจัดการ" ในไฟล์ Manifest
พารามิเตอร์
-
manifestStr
string
สตริง JSON ของไฟล์ Manifest ของส่วนขยาย
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
มีลักษณะดังนี้(permissionWarnings: string[]) => void
-
permissionWarnings
สตริง[]
-
การคืนสินค้า
-
คำสัญญา<string[]>
Chrome เวอร์ชัน 88 ขึ้นไปPromiss รองรับเฉพาะไฟล์ Manifest V3 ขึ้นไป ส่วนแพลตฟอร์มอื่นๆ จะต้องใช้โค้ดเรียกกลับ
getSelf()
chrome.management.getSelf(
callback?: function,
)
แสดงผลข้อมูลเกี่ยวกับส่วนขยายการโทร แอป หรือธีม หมายเหตุ: คุณใช้ฟังก์ชันนี้ได้โดยไม่ต้องขอสิทธิ์ "การจัดการ" ในไฟล์ Manifest
พารามิเตอร์
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
มีลักษณะดังนี้(result: ExtensionInfo) => void
-
ผลลัพธ์
-
การคืนสินค้า
-
Promise<ExtensionInfo>
Chrome เวอร์ชัน 88 ขึ้นไปPromiss รองรับเฉพาะไฟล์ Manifest V3 ขึ้นไป ส่วนแพลตฟอร์มอื่นๆ จะต้องใช้โค้ดเรียกกลับ
installReplacementWebApp()
chrome.management.installReplacementWebApp(
callback?: function,
)
เรียกใช้ insert_web_app ที่ระบุไว้ในไฟล์ Manifest แจ้งให้ผู้ใช้ติดตั้ง หากยังไม่ได้ติดตั้ง
พารามิเตอร์
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
มีลักษณะดังนี้() => void
การคืนสินค้า
-
Promise<void>
Chrome เวอร์ชัน 88 ขึ้นไปPromiss รองรับเฉพาะไฟล์ Manifest V3 ขึ้นไป ส่วนแพลตฟอร์มอื่นๆ จะต้องใช้โค้ดเรียกกลับ
launchApp()
chrome.management.launchApp(
id: string,
callback?: function,
)
เปิดแอปพลิเคชัน
พารามิเตอร์
-
id
string
รหัสส่วนขยายของแอปพลิเคชัน
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
มีลักษณะดังนี้() => void
การคืนสินค้า
-
Promise<void>
Chrome เวอร์ชัน 88 ขึ้นไปPromiss รองรับเฉพาะไฟล์ Manifest V3 ขึ้นไป ส่วนแพลตฟอร์มอื่นๆ จะต้องใช้โค้ดเรียกกลับ
setEnabled()
chrome.management.setEnabled(
id: string,
enabled: boolean,
callback?: function,
)
เปิดหรือปิดใช้แอปหรือส่วนขยาย ในกรณีส่วนใหญ่ จะต้องเรียกใช้ฟังก์ชันนี้ในบริบทของท่าทางสัมผัสของผู้ใช้ (เช่น เครื่องจัดการ click สำหรับปุ่ม) และอาจแสดง UI การยืนยันแบบเนทีฟแก่ผู้ใช้เพื่อช่วยป้องกันการละเมิด
พารามิเตอร์
-
id
string
ซึ่งควรเป็นรหัสจากรายการของ
management.ExtensionInfo
-
เปิดใช้อยู่
boolean
ควรเปิดหรือปิดใช้รายการนี้
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
มีลักษณะดังนี้() => void
การคืนสินค้า
-
Promise<void>
Chrome เวอร์ชัน 88 ขึ้นไปPromiss รองรับเฉพาะไฟล์ Manifest V3 ขึ้นไป ส่วนแพลตฟอร์มอื่นๆ จะต้องใช้โค้ดเรียกกลับ
setLaunchType()
chrome.management.setLaunchType(
id: string,
launchType: LaunchType,
callback?: function,
)
ตั้งค่าประเภทการเปิดตัวของแอป
พารามิเตอร์
-
id
string
ค่านี้ควรเป็นรหัสจากรายการแอปของ
management.ExtensionInfo
-
launchType
ประเภทการเปิดตัวเป้าหมาย โปรดตรวจสอบและตรวจสอบว่าการเปิดตัวประเภทนี้อยู่ใน
ExtensionInfo.availableLaunchTypes
เสมอ เนื่องจากประเภทการเปิดตัวที่พร้อมใช้งานจะแตกต่างกันไปในแพลตฟอร์มและการกําหนดค่าที่แตกต่างกัน -
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
มีลักษณะดังนี้() => void
การคืนสินค้า
-
Promise<void>
Chrome เวอร์ชัน 88 ขึ้นไปPromiss รองรับเฉพาะไฟล์ Manifest V3 ขึ้นไป ส่วนแพลตฟอร์มอื่นๆ จะต้องใช้โค้ดเรียกกลับ
uninstall()
chrome.management.uninstall(
id: string,
options?: UninstallOptions,
callback?: function,
)
ถอนการติดตั้งแอปหรือส่วนขยายที่ติดตั้งอยู่ในปัจจุบัน หมายเหตุ: ฟังก์ชันนี้ไม่ทำงานในสภาพแวดล้อมที่มีการจัดการเมื่อผู้ใช้ไม่ได้รับอนุญาตให้ถอนการติดตั้งส่วนขยาย/แอปที่ระบุ หากถอนการติดตั้งไม่สำเร็จ (เช่น ผู้ใช้ยกเลิกกล่องโต้ตอบ) ระบบจะปฏิเสธสัญญาหรือการเรียกกลับด้วยการตั้งค่า runtime.lastError
พารามิเตอร์
-
id
string
ซึ่งควรเป็นรหัสจากรายการของ
management.ExtensionInfo
-
ตัวเลือก
UninstallOptions ไม่บังคับ
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
มีลักษณะดังนี้() => void
การคืนสินค้า
-
Promise<void>
Chrome เวอร์ชัน 88 ขึ้นไปPromiss รองรับเฉพาะไฟล์ Manifest V3 ขึ้นไป ส่วนแพลตฟอร์มอื่นๆ จะต้องใช้โค้ดเรียกกลับ
uninstallSelf()
chrome.management.uninstallSelf(
options?: UninstallOptions,
callback?: function,
)
ถอนการติดตั้งส่วนขยายการโทร หมายเหตุ: คุณใช้ฟังก์ชันนี้ได้โดยไม่ต้องขอสิทธิ์ "การจัดการ" ในไฟล์ Manifest ฟังก์ชันนี้จะไม่ทำงานในสภาพแวดล้อมที่มีการจัดการเมื่อผู้ใช้ไม่ได้รับอนุญาตให้ถอนการติดตั้งส่วนขยาย/แอปที่ระบุ
พารามิเตอร์
-
ตัวเลือก
UninstallOptions ไม่บังคับ
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
มีลักษณะดังนี้() => void
การคืนสินค้า
-
Promise<void>
Chrome เวอร์ชัน 88 ขึ้นไปPromiss รองรับเฉพาะไฟล์ Manifest V3 ขึ้นไป ส่วนแพลตฟอร์มอื่นๆ จะต้องใช้โค้ดเรียกกลับ
กิจกรรม
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
string
-