browser.idle

Descrição

Use a API chrome.idle para detectar quando o estado de inatividade da máquina muda.

Permissões

idle

É necessário declarar a permissão "idle" no manifesto da extensão para usar a API Idle. Por exemplo:

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

Tipos

IdleState

Chrome 44+ browser.* desde o Chrome 148

Enumeração

"active"

"idle"

"locked"

Métodos

getAutoLockDelay()

Chrome 73+ browser.* desde o Chrome 148 Somente ChromeOS
browser.idle.getAutoLockDelay(): Promise<number>

Informa o tempo, em segundos, que leva até que a tela seja bloqueada automaticamente quando o dispositivo está inativo. Retorna uma duração de zero se a tela nunca for bloqueada automaticamente. No momento, só há suporte para o ChromeOS.

Retorna

  • Promise<number>

    Chrome 116+ browser.* desde o Chrome 148

queryState()

browser.idle.queryState(
  detectionIntervalInSeconds: number,
)
: Promise<IdleState>

Retorna "locked" se o sistema estiver bloqueado, "idle" se o usuário não tiver gerado nenhuma entrada por um número especificado de segundos ou "active" caso contrário.

Parâmetros

  • detectionIntervalInSeconds

    número

    O sistema é considerado inativo se detectionIntervalInSeconds segundos tiverem se passado desde a última entrada do usuário detectada.

Retorna

  • Promise<IdleState>

    Chrome 116+ browser.* desde o Chrome 148

setDetectionInterval()

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

Define o intervalo, em segundos, usado para determinar quando o sistema está em um estado inativo para eventos onStateChanged. O intervalo padrão é de 60 segundos.

Parâmetros

  • intervalInSeconds

    número

    Limite, em segundos, usado para determinar quando o sistema está em um estado inativo.

Eventos

onStateChanged

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

Disparado quando o sistema muda para um estado ativo, inativo ou bloqueado. O evento é acionado com "locked" se a tela estiver bloqueada ou o protetor de tela for ativado, "idle" se o sistema estiver desbloqueado e o usuário não tiver gerado nenhuma entrada por um número especificado de segundos e "active" quando o usuário gerar entrada em um sistema inativo.

Parâmetros

  • callback

    função

    O parâmetro callback é semelhante a:

    (newState: IdleState) => void