chrome.idle

Opis

Użyj interfejsu chrome.idle API, aby wykrywać zmiany stanu bezczynności urządzenia.

Uprawnienia

idle

Plik manifestu

Aby korzystać z interfejsu API idle, musisz zadeklarować uprawnienie „idle” w pliku manifestu rozszerzenia. Przykład:

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

Typy

IdleState

Chrome 44 lub nowszy

Typ wyliczeniowy

„aktywny”

„idle”

„locked”

Metody

getAutoLockDelay()

Promise Chrome w wersji 73 lub nowszej Tylko ChromeOS 
chrome.idle.getAutoLockDelay(
  callback?: function,
): Promise<number>

Pobiera czas (w sekundach), po jakim ekran jest automatycznie blokowany w stanie bezczynności. Jeśli ekran nigdy nie jest blokowany automatycznie, zwraca czas trwania równy zero. Obecnie obsługiwane tylko w ChromeOS.

Parametry

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    (delay: number) => void

    • opóźnienia

      liczba

      Czas w sekundach, po którym ekran jest automatycznie blokowany w stanie bezczynności. Jeśli ekran nigdy nie blokuje się automatycznie, ta wartość wynosi 0.

Zwroty

  • Promise<number>

    Chrome 116 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

queryState()

Obietnica 
chrome.idle.queryState(
  detectionIntervalInSeconds: number,
  callback?: function,
): Promise<IdleState>

Zwraca wartość „locked”, jeśli system jest zablokowany, „idle”, jeśli użytkownik nie wprowadził żadnych danych przez określony czas, lub „active” w innych przypadkach.

Parametry

  • detectionIntervalInSeconds

    liczba

    System jest uznawany za nieaktywny, jeśli od ostatniej wykrytej interakcji użytkownika upłynęło detectionIntervalInSeconds sekund.

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    (newState: IdleState) => void

Zwroty

  • Promise<IdleState>

    Chrome 116 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

setDetectionInterval()

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

Ustawia interwał w sekundach używany do określania, kiedy system jest w stanie bezczynności w przypadku zdarzeń onStateChanged. Domyślny interwał to 60 sekund.

Parametry

  • intervalInSeconds

    liczba

    Próg w sekundach używany do określania, kiedy system jest w stanie bezczynności.

Wydarzenia

onStateChanged

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

Wyzwalane, gdy system przechodzi w stan aktywny, bezczynny lub zablokowany. Zdarzenie jest wywoływane z wartością „locked”, jeśli ekran jest zablokowany lub wygaszacz jest aktywny, „idle”, jeśli system jest odblokowany, a użytkownik nie wykonał żadnej czynności przez określony czas, oraz „active”, gdy użytkownik wykona czynność w nieaktywnym systemie.

Parametry

  • callback

    funkcja

    Parametr callback wygląda tak:

    (newState: IdleState) => void