chrome.idle

תיאור

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

הרשאות

idle

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

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

סוגים

IdleState

Chrome 44 ואילך

Enum

"פעיל"

"לא פעיל"

'נעול'

שיטות

getAutoLockDelay()

הבטחה Chrome מגרסה 73 ואילך ChromeOS בלבד 
chrome.idle.getAutoLockDelay(
  callback?: function,
)

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

פרמטרים

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

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

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

    (delay: number) => void

    • עיכוב

      number

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

החזרות

  • Promise<number>

    Chrome 116 ואילך

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

queryState()

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

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

פרמטרים

  • detectionIntervalInSeconds

    number

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

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

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

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

    (newState: IdleState) => void

החזרות

  • Promise<IdleState>

    Chrome 116 ואילך

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

setDetectionInterval()

chrome.idle.setDetectionInterval(
  intervalInSeconds: number,
)

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

פרמטרים

  • intervalInSeconds

    number

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

אירועים

onStateChanged

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

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

פרמטרים

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

    פונקציה

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

    (newState: IdleState) => void