chrome.idle

說明

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

權限

idle

資訊清單

您必須宣告「閒置」權限，才能使用閒置 API。例如：

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

類型

IdleState

Chrome 44 以上版本

列舉

"active"

"idle"

"已鎖定"

方法

getAutoLockDelay()

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

取得時間 (以秒為單位)，直到螢幕自動鎖定為止。如果螢幕一律不會自動鎖定，則傳回零持續時間。目前僅支援 ChromeOS。

參數

  • 回呼

    函式 選用

    callback 參數如下所示： 

    (delay: number) => void

    • delay

      數字

      時間 (以秒為單位)，直到螢幕在閒置狀態時自動鎖定為止。如果螢幕一律不會自動鎖定，則為 0。

傳回

  • Promise<number>

    Chrome 116 以上版本

    Promise 僅適用於 Manifest V3 及以上版本，其他平台需要使用回呼。

queryState()

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

傳回「已鎖定」訊息如果系統鎖定，「閒置」如果使用者未在指定秒數內產生任何輸入值，或是設為「active」反之。

參數

  • detectionIntervalInSeconds

    數字

    如果 DetectionIntervalInSeconds 秒鐘時間是系統從上次偵測到使用者輸入的時間起算，系統就會視為閒置。

  • 回呼

    函式 選用

    callback 參數如下所示： 

    (newState: IdleState) => void

傳回

  • Promise<IdleState>

    Chrome 116 以上版本

    Promise 僅適用於 Manifest V3 及以上版本，其他平台需要使用回呼。

setDetectionInterval()

chrome.idle.setDetectionInterval(
  intervalInSeconds: number,
)

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

參數

  • intervalInSeconds

    數字

    門檻 (以秒為單位)，用來決定系統何時處於閒置狀態。

活動

onStateChanged

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

系統變更為「活動」、「閒置」或「鎖定」狀態時觸發。事件觸發時會顯示「已鎖定」如果螢幕已鎖定或螢幕保護程式啟動，請說出「閒置」當系統解鎖時，使用者未產生任何指定秒數的輸入內容，而「作用中」當使用者在閒置系統產生輸入內容時。

參數

  • 回呼

    函式

    callback 參數如下所示： 

    (newState: IdleState) => void