chrome.idle

說明

使用 chrome.idle API 偵測機器的閒置狀態何時變更。

權限

idle

您必須在擴充功能的資訊清單中宣告 "idle" 權限,才能使用閒置 API。舉例來說:

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

類型

IdleState

Chrome 44 以上版本

列舉

方法

getAutoLockDelay()

Promise Chrome 73 以上版本 僅限 ChromeOS
chrome.idle.getAutoLockDelay(
  callback?: function,
)

取得等待時間 (秒),讓螢幕在閒置時自動鎖定。如果螢幕一律不自動鎖定,會傳回零時間長度。這項功能目前僅適用於 ChromeOS。

參數

  • 回呼

    函式選用

    callback 參數如下所示:

    (delay: number)=>void

    • delay

      號碼

      時間 (以秒為單位),直到螢幕在閒置時自動鎖定。如果螢幕永不自動鎖定,則值為 0。

傳回

  • Promise<number>

    Chrome 116 以上版本

    Manifest V3 以上版本支援 Promise,但是為了提供回溯相容性而提供的回呼。您無法在同一個函式呼叫中同時使用這兩者。承諾會用傳遞至回呼的同類型解析。

queryState()

Promise
chrome.idle.queryState(
  detectionIntervalInSeconds: number,
  callback?: function,
)

如果系統處於鎖定狀態,系統會傳回「已鎖定」;如果使用者超過指定的秒數,則傳回「閒置」,否則傳回「啟用」。

參數

  • detectionIntervalInSeconds

    號碼

    如果偵測間隔秒數自上次偵測到使用者輸入內容後已過,系統就會將其視為閒置。

  • 回呼

    函式選用

    callback 參數如下所示:

    (newState: IdleState)=>void

傳回

  • Promise<IdleState>

    Chrome 116 以上版本

    Manifest V3 以上版本支援 Promise,但是為了提供回溯相容性而提供的回呼。您無法在同一個函式呼叫中同時使用這兩者。承諾會用傳遞至回呼的同類型解析。

setDetectionInterval()

chrome.idle.setDetectionInterval(
  intervalInSeconds: number,
)

設定間隔 (以秒為單位),用來判斷系統何時為 onStateChanged 事件處於閒置狀態。預設間隔為 60 秒。

參數

  • intervalInSeconds

    號碼

    門檻 (以秒為單位) 可用於判斷系統何時處於閒置狀態。

活動

onStateChanged

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

系統變更為有效、閒置或鎖定狀態時觸發。如果螢幕處於鎖定狀態或螢幕保護程式啟動,系統會觸發事件,並顯示「閒置」,表示系統處於解鎖狀態且使用者未在指定秒數時產生任何輸入內容;當使用者在閒置系統上產生輸入內容時,就會觸發「閒置」。

參數

  • 回呼

    功能

    callback 參數如下所示:

    (newState: IdleState)=>void