chrome.alarms

คำอธิบาย

สิทธิ์

หากต้องการใช้ chrome.alarms API ให้ประกาศสิทธิ์ "alarms" ใน Manifest ดังนี้

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

แนวคิดและการใช้งาน

การทำความเข้าใจลักษณะการทำงานของ API จะช่วยให้มั่นใจได้ถึงลักษณะการทำงานที่เชื่อถือได้

อุปกรณ์เข้าสู่โหมดสลีป

การปลุกจะยังคงทำงานขณะที่อุปกรณ์อยู่ในโหมดสลีป แต่สัญญาณปลุกจะไม่ ปลุกระบบอุปกรณ์ เมื่ออุปกรณ์ตื่นขึ้น นาฬิกาปลุกที่พลาดไปจะดังขึ้น การปลุกซ้ำจะทำงานอย่างน้อย 1 ครั้ง จากนั้นจะกำหนดเวลาใหม่โดยใช้ ระยะเวลาที่ระบุซึ่งเริ่มตั้งแต่เวลาที่อุปกรณ์ตื่น โดยไม่คำนึงถึง เวลาที่ผ่านไปแล้วนับตั้งแต่ที่ตั้งค่าการปลุกให้ทำงานในตอนแรก

ความต่อเนื่อง

คุณควบคุมความต่อเนื่องของนาฬิกาปลุกได้ในเวลาที่สร้างโดยใช้แฟล็ก persistAcrossSessions โดยตั้งค่าเป็น true (คงอยู่จนกว่าส่วนขยายจะอัปเดต) หรือ false (ล้างหากมีการโหลดส่วนขยายซ้ำหรือเบราว์เซอร์รีสตาร์ท และทุกครั้งที่ส่วนขยายอัปเดต) ได้

เบราว์เซอร์อื่นๆ และ Chrome เวอร์ชันก่อนหน้า

เบราว์เซอร์อื่นๆ ไม่รองรับพร็อพเพอร์ตี้นี้ (ปัญหา) รวมถึง Chrome เวอร์ชันก่อน Chrome 150 ซึ่งอาจมีลักษณะการทำงานที่ไม่แน่นอน ดังนั้น คุณควรตรวจสอบว่ามีการตั้งปลุกที่สำคัญทุกครั้งที่ Service Worker เริ่มทำงาน เช่น

async function checkAlarmState() {
  const alarm = await chrome.alarms.get("my-alarm");

  if (!alarm) {
    await chrome.alarms.create("my-alarm", { periodInMinutes: 1 });
  }
}

checkAlarmState();

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

ตัวอย่าง

ตัวอย่างต่อไปนี้แสดงวิธีใช้และตอบสนองต่อการปลุก หากต้องการลองใช้ API นี้ ให้ติดตั้งตัวอย่าง Alarm API จากที่เก็บchrome-extension-samples

ตั้งปลุก

ตัวอย่างต่อไปนี้จะตั้งปลุกใน Service Worker เมื่อมีการติดตั้งส่วนขยายเวอร์ชันใหม่

service-worker.js:

chrome.runtime.onInstalled.addListener(async ({ reason }) => {
  // Create an alarm so we have something to look at in the demo
  await chrome.alarms.create('demo-default-alarm', {
    delayInMinutes: 1,
    periodInMinutes: 1,
    persistAcrossSessions: true
  });
});

ตอบสนองต่อสัญญาณเตือน

ตัวอย่างต่อไปนี้จะตั้งค่าไอคอนแถบเครื่องมือการดำเนินการตามชื่อของการปลุกที่ดังขึ้น

service-worker.js:

chrome.alarms.onAlarm.addListener((alarm) => {
  chrome.action.setIcon({
    path: getIconPath(alarm.name),
  });
});

chrome.alarms.clear(
  name?: string,
): Promise<boolean>

chrome.alarms.clearAll(): Promise<boolean>

chrome.alarms.create(
  name?: string,
  alarmInfo: AlarmCreateInfo,
): Promise<void>

chrome.alarms.get(
  name?: string,
): Promise<Alarm | undefined>

chrome.alarms.getAll(): Promise<Alarm[]>

chrome.alarms.onAlarm.addListener(
  callback: function,
)