chrome.notifications

refresh date: 2026-09-25 robots: noindex

คำอธิบาย

ใช้ chrome.notifications API เพื่อสร้างการแจ้งเตือนที่สมบูรณ์โดยใช้เทมเพลตและแสดงการแจ้งเตือนเหล่านี้ต่อผู้ใช้ในถาดระบบ

สิทธิ์

notifications

ประเภท

NotificationBitmap

NotificationButton

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

  • iconUrl

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

    เลิกใช้งานตั้งแต่ Chrome 59

    ไอคอนปุ่มไม่แสดงสำหรับผู้ใช้ Mac OS X

  • title

    สตริง

NotificationItem

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

  • ข้อความ

    สตริง

    รายละเอียดเพิ่มเติมเกี่ยวกับรายการนี้

  • title

    สตริง

    ชื่อของรายการหนึ่งในการแจ้งเตือนแบบรายการ

NotificationOptions

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

  • appIconMaskUrl

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

    เลิกใช้งานตั้งแต่ Chrome 59

    ผู้ใช้ Mac OS X จะไม่เห็นมาสก์ไอคอนแอป

    URL ไปยังมาสก์ไอคอนแอป URL มีข้อจำกัดเช่นเดียวกับ iconUrl

    มาสก์ไอคอนแอปควรอยู่ในช่องอัลฟ่า เนื่องจากระบบจะพิจารณาเฉพาะช่องอัลฟ่าของรูปภาพเท่านั้น

  • ปุ่ม

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

    ข้อความและไอคอนสำหรับปุ่มดำเนินการของการแจ้งเตือนสูงสุด 2 ปุ่ม

  • contextMessage

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

    เนื้อหาการแจ้งเตือนสำรองที่มีแบบอักษรน้ำหนักเบากว่า

  • eventTime

    number ไม่บังคับ

    การประทับเวลาที่เชื่อมโยงกับการแจ้งเตือนในหน่วยมิลลิวินาทีที่ผ่านไปนับตั้งแต่ Epoch (เช่น Date.now() + n)

  • iconUrl

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

    URL ของรูปโปรไฟล์ของผู้ส่ง ไอคอนแอป หรือภาพขนาดย่อสำหรับการแจ้งเตือนรูปภาพ

    URL อาจเป็น URL ข้อมูล, URL ของ Blob หรือ URL ที่สัมพันธ์กับทรัพยากรภายในไฟล์ .crx ของส่วนขยายนี้

    **หมายเหตุ:**ต้องระบุค่านี้สำหรับเมธอด notifications.create()

  • imageUrl

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

    เลิกใช้งานตั้งแต่ Chrome 59

    รูปภาพจะไม่แสดงต่อผู้ใช้ Mac OS X

    URL ของรูปภาพขนาดย่อสำหรับการแจ้งเตือนประเภทรูปภาพ URL มีข้อจำกัดเช่นเดียวกับ iconUrl

  • isClickable

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

    เลิกใช้งานตั้งแต่ Chrome 67

    ระบบจะไม่สนใจคำแนะนำ UI นี้ตั้งแต่ Chrome 67 เป็นต้นไป

  • รายการ

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

    รายการสำหรับการแจ้งเตือนหลายรายการ ผู้ใช้ Mac OS X จะเห็นเฉพาะรายการแรกเท่านั้น

  • ข้อความ

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

    เนื้อหาหลักของการแจ้งเตือน

    **หมายเหตุ:**ต้องระบุค่านี้สำหรับเมธอด notifications.create()

  • ลำดับความสำคัญ

    number ไม่บังคับ

    ลำดับความสำคัญมีตั้งแต่ -2 ถึง 2 -2 คือลำดับความสำคัญต่ำสุด 2 คือสูงสุด ค่าเริ่มต้นคือ 0 ในแพลตฟอร์มที่ไม่รองรับศูนย์การแจ้งเตือน (Windows, Linux และ Mac) -2 และ -1 จะทำให้เกิดข้อผิดพลาดเนื่องจากการแจ้งเตือนที่มีลำดับความสำคัญเหล่านั้นจะไม่แสดงเลย

  • ความคืบหน้า

    number ไม่บังคับ

    ความคืบหน้าปัจจุบันมีตั้งแต่ 0 ถึง 100

  • requireInteraction

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

    Chrome 50 ขึ้นไป

    ระบุว่าการแจ้งเตือนควรยังคงปรากฏบนหน้าจอจนกว่าผู้ใช้จะเปิดใช้งานหรือปิดการแจ้งเตือน ค่าเริ่มต้นคือ false

  • ปิดเสียง

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

    Chrome 70 ขึ้นไป

    ระบุว่าไม่ควรส่งเสียงหรือสั่นเมื่อแสดงการแจ้งเตือน ค่าเริ่มต้นคือ false

  • title

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

    ชื่อของการแจ้งเตือน (เช่น ชื่อผู้ส่งอีเมล)

    **หมายเหตุ:**ต้องระบุค่านี้สำหรับเมธอด notifications.create()

  • ประเภท

    TemplateType ไม่บังคับ

    ประเภทการแจ้งเตือนที่จะแสดง ต้องระบุสำหรับเมธอด notifications.create

PermissionLevel

ค่าแจกแจง

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

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

TemplateType

ค่าแจกแจง

"basic"
มีไอคอน, ชื่อ, ข้อความ, expandedMessage และปุ่มสูงสุด 2 ปุ่ม

"image"
มีไอคอน, ชื่อ, ข้อความ, expandedMessage, รูปภาพ และปุ่มสูงสุด 2 ปุ่ม

"list"
มีไอคอน ชื่อ ข้อความ รายการ และปุ่มสูงสุด 2 ปุ่ม ผู้ใช้ Mac OS X จะเห็นเฉพาะรายการแรกเท่านั้น

"progress"
มีไอคอน ชื่อ ข้อความ ความคืบหน้า และปุ่มสูงสุด 2 ปุ่ม

เมธอด

clear()

Promise 
chrome.notifications.clear(
  notificationId: string,
  callback?: function,
): Promise<boolean>

ล้างการแจ้งเตือนที่ระบุ

พารามิเตอร์

  • notificationId

    สตริง

    รหัสของการแจ้งเตือนที่จะล้าง ซึ่งแสดงผลโดยเมธอด notifications.create

  • callback

    function ไม่บังคับ

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

    (wasCleared: boolean) => void

    • wasCleared

      บูลีน

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

  • Promise<boolean>

    Chrome 116 ขึ้นไป

    แสดงผล Promise ซึ่งจะได้รับการแก้ไขเพื่อระบุว่ามีการแจ้งเตือนที่ตรงกันหรือไม่

    ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

create()

Promise 
chrome.notifications.create(
  notificationId?: string,
  options: NotificationOptions,
  callback?: function,
): Promise<string>

สร้างและแสดงการแจ้งเตือน

พารามิเตอร์

  • notificationId

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

    ตัวระบุของการแจ้งเตือน หากไม่ได้ตั้งค่าหรือเว้นว่างไว้ ระบบจะสร้างรหัสโดยอัตโนมัติ หากตรงกับการแจ้งเตือนที่มีอยู่ เมธอดนี้จะล้างการแจ้งเตือนนั้นก่อนดำเนินการสร้าง ตัวระบุต้องมีความยาวไม่เกิน 500 อักขระ

    ต้องระบุพารามิเตอร์ notificationId ก่อน Chrome 42

  • ตัวเลือก

    NotificationOptions

    เนื้อหาของการแจ้งเตือน

  • callback

    function ไม่บังคับ

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

    (notificationId: string) => void

    • notificationId

      สตริง

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

  • Promise<string>

    Chrome 116 ขึ้นไป

    แสดงผล Promise ซึ่งจะแก้ไขด้วยรหัสการแจ้งเตือน (ที่ระบุหรือสร้างขึ้น) ซึ่งแสดงถึงการแจ้งเตือนที่สร้างขึ้น

    ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

getAll()

Promise 
chrome.notifications.getAll(
  callback?: function,
): Promise<object>

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

พารามิเตอร์

  • callback

    function ไม่บังคับ

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

    (notifications: object) => void

    • การแจ้งเตือน

      ออบเจ็กต์

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

  • Promise<object>

    Chrome 116 ขึ้นไป

    แสดงผล Promise ซึ่งจะแก้ไขด้วยชุด notification_id ที่อยู่ในระบบปัจจุบัน

    ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

getPermissionLevel()

Promise 
chrome.notifications.getPermissionLevel(
  callback?: function,
): Promise<PermissionLevel>

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

พารามิเตอร์

  • callback

    function ไม่บังคับ

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

    (level: PermissionLevel) => void

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

  • Promise<PermissionLevel>

    Chrome 116 ขึ้นไป

    แสดงผล Promise ซึ่งจะแก้ไขด้วยระดับสิทธิ์ปัจจุบัน

    ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

update()

Promise 
chrome.notifications.update(
  notificationId: string,
  options: NotificationOptions,
  callback?: function,
): Promise<boolean>

อัปเดตการแจ้งเตือนที่มีอยู่

พารามิเตอร์

  • notificationId

    สตริง

    รหัสของการแจ้งเตือนที่จะอัปเดต ซึ่งแสดงผลโดยเมธอด notifications.create

  • ตัวเลือก

    NotificationOptions

    เนื้อหาของการแจ้งเตือนที่จะอัปเดต

  • callback

    function ไม่บังคับ

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

    (wasUpdated: boolean) => void

    • wasUpdated

      บูลีน

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

  • Promise<boolean>

    Chrome 116 ขึ้นไป

    แสดงผล Promise ซึ่งจะได้รับการแก้ไขเพื่อระบุว่ามีการแจ้งเตือนที่ตรงกันหรือไม่

    ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

กิจกรรม

onButtonClicked

chrome.notifications.onButtonClicked.addListener(
  callback: function,
)

ผู้ใช้กดปุ่มในการแจ้งเตือน

พารามิเตอร์

  • callback

    ฟังก์ชัน

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

    (notificationId: string, buttonIndex: number) => void

    • notificationId

      สตริง

    • buttonIndex

      ตัวเลข

onClicked

chrome.notifications.onClicked.addListener(
  callback: function,
)

ผู้ใช้คลิกในพื้นที่ที่ไม่ใช่ปุ่มของการแจ้งเตือน

พารามิเตอร์

  • callback

    ฟังก์ชัน

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

    (notificationId: string) => void

    • notificationId

      สตริง

onClosed

chrome.notifications.onClosed.addListener(
  callback: function,
)

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

พารามิเตอร์

  • callback

    ฟังก์ชัน

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

    (notificationId: string, byUser: boolean) => void

    • notificationId

      สตริง

    • byUser

      บูลีน

onPermissionLevelChanged

chrome.notifications.onPermissionLevelChanged.addListener(
  callback: function,
)

ผู้ใช้เปลี่ยนระดับสิทธิ์ ตั้งแต่ Chrome 47 เป็นต้นไป มีเพียง ChromeOS เท่านั้นที่มี UI ที่ส่งเหตุการณ์นี้

พารามิเตอร์

  • callback

    ฟังก์ชัน

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

    (level: PermissionLevel) => void

onShowSettings

เลิกใช้งานตั้งแต่ Chrome 65
chrome.notifications.onShowSettings.addListener(
  callback: function,
)

ระบบไม่รองรับปุ่มการตั้งค่าการแจ้งเตือนที่กำหนดเองอีกต่อไป

ผู้ใช้คลิกลิงก์สำหรับการตั้งค่าการแจ้งเตือนของแอป ตั้งแต่ Chrome 47 เป็นต้นไป มีเพียง ChromeOS เท่านั้นที่มี UI ที่ส่งเหตุการณ์นี้ ตั้งแต่ Chrome 65 เป็นต้นมา UI ดังกล่าวได้ถูกนำออกจาก ChromeOS ด้วยเช่นกัน

พารามิเตอร์

  • callback

    ฟังก์ชัน

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

    () => void