chrome.idle

Descrição

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

Permissões

idle

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

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

Tipos

IdleState

Chrome 44 ou superior

Enumeração

"ativo"

"inativo"

"bloqueado"

Métodos

getAutoLockDelay()

Promessa Chrome 73 ou versão mais recente Somente ChromeOS 
chrome.idle.getAutoLockDelay(
  callback?: function,
)

Mostra o tempo, em segundos, necessário para que a tela seja bloqueada automaticamente enquanto estiver ociosa. Retornará uma duração zero se a tela nunca for bloqueada automaticamente. No momento, esse recurso só está disponível no Chrome OS.

Parâmetros

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (delay: number) => void

    • delay

      number

      Tempo, em segundos, até que a tela seja bloqueada automaticamente enquanto estiver ociosa. Esse valor é zero se a tela nunca é bloqueada automaticamente.

Retorna

  • Promise<number>

    Chrome 116 ou versões mais recentes

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

queryState()

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

Retorna "bloqueado" se o sistema estiver bloqueado, "inativo" se o usuário não tiver gerado nenhuma entrada para um número especificado de segundos ou "ativo" caso contrário.

Parâmetros

  • detectionIntervalInSeconds

    number

    O sistema é considerado inativo quando detectIntervalInSeconds segundos se passam desde a última entrada do usuário detectada.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (newState: IdleState) => void

Retorna

  • Promise<IdleState>

    Chrome 116 ou versões mais recentes

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

setDetectionInterval()

chrome.idle.setDetectionInterval(
  intervalInSeconds: number,
)

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

    number

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

Eventos

onStateChanged

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

Disparado quando o sistema muda para um estado ativo, inativo ou bloqueado. O evento é disparado com a mensagem se a tela estiver bloqueada ou o protetor de tela for ativado, "ocioso" se o sistema está desbloqueado e o usuário não gerou nenhuma entrada por um número especificado de segundos e "ativo" quando o usuário gera entradas em um sistema ocioso.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (newState: IdleState) => void