chrome.idle

תיאור

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

הרשאות

idle

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

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

סוגים

IdleState

‫Chrome 44 ואילך

Enum

‫'active'

"idle"

"locked"

Methods

getAutoLockDelay()

‫Chrome 73 ואילך ChromeOS בלבד 
chrome.idle.getAutoLockDelay(): Promise<number>

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

החזרות

  • Promise<number>

    ‫Chrome 116 ואילך

queryState()

chrome.idle.queryState(
  detectionIntervalInSeconds: number,
): Promise<IdleState>

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

פרמטרים

  • detectionIntervalInSeconds

    number

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

החזרות

  • Promise<IdleState>

    ‫Chrome 116 ואילך

setDetectionInterval()

chrome.idle.setDetectionInterval(
  intervalInSeconds: number,
): void

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

פרמטרים

  • intervalInSeconds

    number

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

אירועים

onStateChanged

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

האירוע מופעל כשהמערכת משתנה למצב פעיל, למצב לא פעיל או למצב נעול. האירוע מופעל עם הערך 'locked' אם המסך נעול או אם שומר המסך מופעל, עם הערך 'idle' אם המערכת לא נעולה והמשתמש לא הזין קלט במשך מספר שניות שצוין, ועם הערך 'active' כשהמשתמש מזין קלט במערכת לא פעילה.

פרמטרים

  • callback

    פונקציה

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

    (newState: IdleState) => void