chrome.alarms

תיאור

אפשר להשתמש ב-chrome.alarms API כדי לתזמן קוד להפעלה מעת לעת או בזמן מסוים בעתיד.

הרשאות

alarms

כדי להשתמש ב-chrome.alarms API, צריך להצהיר על ההרשאה "alarms" במניפסט:

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

מושגים ושימוש

כדי להבטיח התנהגות מהימנה, חשוב להבין את אופן הפעולה של ה-API.

מצב שינה במכשיר

השעונים המעוררים ממשיכים לפעול בזמן שהמכשיר במצב שינה. עם זאת, שעון מעורר לא יפעיל את המכשיר. כשהמכשיר יתעורר, כל ההתראות שלא התקבלו יופעלו. התראות חוזרות יופעלו פעם אחת לכל היותר, ואז יתוזמנו מחדש לפי התקופה שצוינה, החל מהרגע שבו המכשיר יופעל. לא יובא בחשבון הזמן שכבר חלף מאז שההתראה הוגדרה להפעלה.

התמדה

אתם יכולים לשלוט בהתמדה של שעון מעורר בזמן היצירה באמצעות הדגל 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.

Set an alarm

בדוגמה הבאה מוגדר שעון מעורר ב-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),
  });
});

סוגים

Alarm

מאפיינים

  • שם

    מחרוזת

    השם של ההתראה.

  • periodInMinutes

    מספר אופציונלי

    אם הערך לא null, מדובר בשעון מעורר חוזר והוא יופעל שוב בעוד periodInMinutes דקות.

  • persistAcrossSessions

    בוליאני

    ‫Chrome 150+

    האם האזעקה צריכה להישמע גם אחרי סגירה של הסשן (הפעלה מחדש של הדפדפן).

  • scheduledTime

    number

    השעה שבה ההתראה הזו אמורה לפעול, באלפיות השנייה שעברו מאז תקופת האפוקה (לדוגמה, Date.now() + n). מטעמי ביצועים, יכול להיות שההתראה תופעל באיחור של פרק זמן כלשהו.

AlarmCreateInfo

מאפיינים

  • delayInMinutes

    מספר אופציונלי

    משך הזמן בדקות שאחריו צריך להפעיל את האירוע onAlarm.

  • שם

    מחרוזת אופציונלי

    ‫Chrome 152 ואילך

    השם של ההתראה.

  • periodInMinutes

    מספר אופציונלי

    אם ההגדרה מוגדרת, האירוע onAlarm אמור להיות מופעל כל periodInMinutes דקות אחרי האירוע הראשוני שצוין על ידי when או delayInMinutes. אם לא מגדירים את האפשרות הזו, השעון המעורר יצלצל רק פעם אחת.

  • persistAcrossSessions

    ‫boolean אופציונלי

    ‫Chrome 150+

    האם האזעקה צריכה להישמע גם אחרי סגירה של הסשן (הפעלה מחדש של הדפדפן). ב-Chrome, ברירת המחדל היא true כדי להתאים להתנהגות היסטורית, אבל כדאי להגדיר את זה במפורש כדי למקסם את התאימות בין דפדפנים.

  • מתי

    מספר אופציונלי

    השעה שבה ההתראה אמורה לפעול, באלפיות השנייה אחרי תקופת הזמן של מערכת (למשל Date.now() + n).

Methods

clear()

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

מחיקה של השעון המעורר עם השם שצוין.

פרמטרים

  • שם

    מחרוזת אופציונלי

    השם של ההתראה שרוצים לבטל. ברירת המחדל היא מחרוזת ריקה.

החזרות

  • Promise<boolean>

    ‫Chrome 91 ואילך

clearAll()

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

מחיקת כל השעונים המעוררים.

החזרות

  • Promise<boolean>

    ‫Chrome 91 ואילך

create()

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

יוצרת שעון מעורר. בסמוך לשעה או לשעות שצוינו על ידי alarmInfo, מופעל האירוע onAlarm. אם יש עוד התראה עם אותו שם (או ללא שם אם לא צוין שם), היא תבוטל ותוחלף בהתראה הזו.

כדי להפחית את העומס על המחשב של המשתמש, Chrome מגביל את ההתראות לפעם אחת לכל היותר בכל 30 שניות, אבל יכול לעכב אותן גם יותר מזה. כלומר, הגדרת הערך של delayInMinutes או periodInMinutes כערך נמוך מ-0.5 לא תכובד ותגרום להצגת אזהרה. when אפשר להגדיר את השעה לזמן קצר מ-30 שניות אחרי השעה הנוכחית בלי לקבל אזהרה, אבל ההתראה לא תופעל בפועל לפני שיחלפו לפחות 30 שניות.

כדי לעזור לכם לנפות באגים באפליקציה או בתוסף, כשאתם טוענים אותם ללא דחיסה, אין הגבלה על התדירות שבה ההתראה יכולה לפעול.

פרמטרים

  • שם

    מחרוזת אופציונלי

    שם אופציונלי לזיהוי ההתראה. ברירת המחדל היא מחרוזת ריקה.

  • alarmInfo

    AlarmCreateInfo

    מתאר מתי השעון המעורר צריך לפעול. צריך לציין את שעת ההתחלה באמצעות when או delayInMinutes (אבל לא את שניהם). אם מוגדר periodInMinutes, ההתראה תחזור על עצמה כל periodInMinutes דקות אחרי האירוע הראשוני. אם לא מוגדרים when או delayInMinutes לשעון מעורר חוזר, periodInMinutes משמש כברירת מחדל לdelayInMinutes.

החזרות

  • Promise<void>

    ‫Chrome 111 ואילך

    הבטחה שמושלמת כשההתראה נוצרת.

get()

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

אחזור פרטים על ההתראה שצוינה.

פרמטרים

  • שם

    מחרוזת אופציונלי

    שם ההתראה שרוצים לאחזר. ברירת המחדל היא מחרוזת ריקה.

החזרות

  • ‫Promise<Alarm | undefined>

    ‫Chrome 91 ואילך

getAll()

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

מחזירה מערך של כל ההתראות.

החזרות

  • Promise<Alarm[]>

    ‫Chrome 91 ואילך

אירועים

onAlarm

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

מופעל כשחולף הזמן שנקבע להתראה. שימושי לדפי אירועים.

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך: 

    (alarm: Alarm) => void