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. Exemplo:

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

Tipos

IdleState

Chrome 44 ou mais recente

Tipo enumerado

Métodos

getAutoLockDelay()

Promise Chrome 73+ Somente ChromeOS 
chrome.idle.getAutoLockDelay(
  callback?: function,
)

Recebe o tempo, em segundos, que leva para a tela ser bloqueada automaticamente enquanto ela estiver inativa. Retorna uma duração zero se a tela nunca for bloqueada automaticamente. No momento, com suporte apenas no Chrome OS.

Parâmetros

  • callback

    função optional

    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 inativa. Esse valor será zero se a tela nunca for bloqueada automaticamente.

Retorna

  • Prometer<número>

    Chrome 116 ou mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

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" se não tiver sido gerado.

Parâmetros

  • detectionIntervalInSeconds

    number

    O sistema é considerado inativo caso detectIntervalInSeconds os segundos desde a última entrada do usuário detectada.

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    (newState: IdleState)=>void

Retorna

  • Promise<IdleState>

    Chrome 116 ou mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

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 o estado ativo, inativo ou bloqueado. O evento é disparado com "bloqueado" se a tela estiver bloqueada ou o protetor de tela for ativado, "inativo" se o sistema estiver desbloqueado e o usuário não tiver gerado nenhuma entrada por um número especificado de segundos e "ativo" quando o usuário gerar uma entrada em um sistema ocioso.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (newState: IdleState)=>void