chrome.idle

תיאור

צריך להשתמש ב-API chrome.idle כדי לזהות שינויים במצב ללא פעילות של המכונה.

הרשאות

idle

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

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

סוגים

IdleState

Chrome 44 ואילך

טיפוסים בני מנייה (enum)

שיטות

getAutoLockDelay()

Promise Chrome 73 ואילך ChromeOS בלבד 
chrome.idle.getAutoLockDelay(
  callback?: function,
)

הפונקציה מקבלת את הזמן בשניות עד שהמסך ננעל באופן אוטומטי במצב ללא פעילות. מחזירה משך זמן של אפס אם המסך אף פעם לא ננעל באופן אוטומטי. בשלב הזה התכונה נתמכת רק ב-Chrome OS.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה אופציונלי

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

    (delay: number)=>void

    • עיכוב

      מספר

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

החזרות

  • הבטחה<number>

    Chrome 116 ומעלה

    יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

queryState()

הבטחה 
chrome.idle.queryState(
  detectionIntervalInSeconds: number,
  callback?: function,
)

מחזירה 'נעול' אם המערכת נעולה, 'לא פעיל' אם המשתמש לא יצר קלט למשך מספר שניות ספציפי, או 'פעיל' אם לא.

פרמטרים

  • detectionIntervalInSeconds

    מספר

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

  • קריאה חוזרת (callback)

    פונקציה אופציונלי

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

    (newState: IdleState)=>void

החזרות

  • Promise<IdleState>

    Chrome 116 ומעלה

    יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

setDetectionInterval()

chrome.idle.setDetectionInterval(
  intervalInSeconds: number,
)

הגדרת המרווח בשניות, שמשמש כדי לקבוע מתי המערכת נמצאת במצב לא פעיל עבור אירועי onStateChanged. מרווח ברירת המחדל הוא 60 שניות.

פרמטרים

  • intervalInSeconds

    מספר

    הסף, בשניות, משמש כדי לקבוע מתי המערכת נמצאת במצב לא פעיל.

אירועים

onStateChanged

chrome.idle.onStateChanged.addListener(
  callback: function,
)

מופעל כשהמערכת עוברת למצב פעיל, לא פעיל או נעול. האירוע מופעל עם "נעול" אם המסך נעול או אם שומר המסך מופעל, "לא פעיל" אם המערכת לא נעולה והמשתמש לא יצר קלט למשך מספר מסוים של שניות, או "פעיל" כאשר המשתמש יוצר קלט במערכת לא פעילה.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה

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

    (newState: IdleState)=>void