chrome.idle

Opis

Interfejs chrome.idle API umożliwia wykrywanie zmian stanu bezczynności urządzenia.

Uprawnienia

idle

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

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

Typy

IdleState

Chrome 44 i nowsze wersje

Enum

Metody

getAutoLockDelay()

Obietnica Chrome 73 i nowsze wersje Tylko ChromeOS 
chrome.idle.getAutoLockDelay(
  callback?: function,
)

Pobiera czas (w sekundach) potrzebny do automatycznego zablokowania ekranu w trakcie bezczynności. Zwraca zerowy czas trwania, jeśli ekran nigdy nie jest automatycznie zablokowany. Ta funkcja jest obecnie obsługiwana tylko w ChromeOS.

Parametry

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    (delay: number)=>void

    • opóźnienia

      Liczba

      Czas (w sekundach) do automatycznego zablokowania ekranu podczas bezczynności. Jeśli ekran nigdy nie blokuje się automatycznie, wartość wynosi zero.

Akcje powrotne

  • Obietnica<number>

    Chrome 116 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

queryState()

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

Zwraca wartość „locked” (zablokowany), jeśli system jest zablokowany, „bezczynny”, jeśli użytkownik nie wygenerował żadnych danych wejściowych przez określoną liczbę sekund, lub „active” (aktywny).

Parametry

  • detectionIntervalInSeconds

    Liczba

    System jest uznawany za bezczynny, jeśli od ostatniego wykrycia ostatniego działania użytkownika upłynęło s sekundy.

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    (newState: IdleState)=>void

Akcje powrotne

  • Promise<IdleState>

    Chrome 116 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika 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 w aktywny, nieaktywny lub zablokowany. Zdarzenie jest uruchamiane z opcją „Zablokowano”, jeśli ekran jest zablokowany lub wygaszacz ekranu się aktywuje, „nieaktywny”, jeśli system jest odblokowany, a użytkownik nie wygenerował żadnych danych wejściowych przez określoną liczbę sekund, oraz „aktywne”, gdy użytkownik wprowadzi dane w nieaktywnym systemie.

Parametry

  • wywołanie zwrotne

    funkcja

    Parametr callback wygląda tak: 

    (newState: IdleState)=>void