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,
)