chrome.idle

Opis

Użyj interfejsu API chrome.idle, aby wykryć zmiany stanu bezczynności maszyny.

Uprawnienia

idle

Aby używać bezczynnego interfejsu API, musisz zadeklarować uprawnienia "idle" w pliku manifestu rozszerzenia. Przykład:

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

Typy

IdleState

Chrome w wersji 44 lub nowszej .

Typ wyliczeniowy

"active"

"idle"

"zablokowany"

Metody

getAutoLockDelay()

Obietnica Chrome w wersji 73 lub nowszej Tylko ChromeOS .
chrome.idle.getAutoLockDelay(
  callback?: function,
)

Określa czas (w sekundach) potrzebny do automatycznego zablokowania ekranu podczas bezczynności. Zwraca wartość 0 czasu, jeśli ekran nigdy nie jest blokowany automatycznie. Obecnie obsługiwane tylko w ChromeOS.

Parametry

  • wywołanie zwrotne

    funkcja optional

    Parametr callback wygląda tak: 

    (delay: number) => void

    • opóźnienia

      liczba

      Czas (w sekundach) do automatycznego blokowania ekranu podczas bezczynności. Jeśli ekran nigdy nie jest blokowany automatycznie, wartość wynosi zero.

Zwroty

  • Promise<number>

    Chrome 116 lub nowszy .

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowana jest realizowane z tym samym typem, który jest przekazywany do wywołania zwrotnego.

queryState()

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

Zwraca stan „zablokowany” jeśli system jest zablokowany, „nieaktywny”; jeśli użytkownik nie wygenerował żadnych danych wejściowych przez określoną liczbę sekund lub element jest „aktywny” w przeciwnym razie.

Parametry

  • detectionIntervalInSeconds

    liczba

    System jest uznawany za nieaktywny, jeśli od wykrycia ostatniego działania użytkownika minęły sekundy, w których minęły:

  • wywołanie zwrotne

    funkcja optional

    Parametr callback wygląda tak: 

    (newState: IdleState) => void

Zwroty

  • Promise<IdleState>

    Chrome 116 lub nowszy .

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowana jest realizowane z tym samym typem, który jest przekazywany do wywołania zwrotnego.

setDetectionInterval()

chrome.idle.setDetectionInterval(
  intervalInSeconds: number,
)

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,
)

Uruchamiane, gdy system zmieni stan na aktywny, nieaktywny lub zablokowany. Zdarzenie jest uruchamiane z komunikatem „Zablokowano” jeśli ekran jest zablokowany lub aktywowany jest wygaszacz ekranu, komunikat „Nieaktywny”. jeśli system jest odblokowany, a użytkownik nie wygenerował żadnych danych wejściowych przez określoną liczbę sekund; stan jest „aktywny”. gdy użytkownik generuje dane wejściowe w nieaktywnym systemie.

Parametry

  • wywołanie zwrotne

    funkcja

    Parametr callback wygląda tak: 

    (newState: IdleState) => void