browser.idle

תיאור

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

הרשאות

idle

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

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

סוגים

IdleState

Chrome 44 ואילך browser.* ‎ מ-Chrome 148

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

"active"

"idle"

"locked"

Methods

getAutoLockDelay()

Chrome 73 ואילך browser.* ‎ מגרסה Chrome 148 ChromeOS בלבד
browser.idle.getAutoLockDelay(): Promise<number>

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

החזרות

  • Promise<number>

    ‫Chrome 116 ואילך ‫browser.* ‎ מ-Chrome 148

queryState()

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

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

פרמטרים

  • detectionIntervalInSeconds

    number

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

החזרות

  • Promise<IdleState>

    ‫Chrome 116 ואילך ‫browser.* ‎ מ-Chrome 148

setDetectionInterval()

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

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

פרמטרים

  • intervalInSeconds

    number

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

אירועים

onStateChanged

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

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

פרמטרים

  • callback

    פונקציה

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

    (newState: IdleState) => void