extensions/common/api/idle.json

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 [
   6   {
   7     "namespace": "idle",
   8     "description": "Use the <code>chrome.idle</code> API to detect when the machine's idle state changes.",
   9     "types": [
  10       {
  11         "id": "IdleState",
  12         "type": "string",
  13         "enum": ["active", "idle", "locked"]
  14       }
  15     ],
  16     "functions": [
  17       {
  18         "name": "queryState",
  19         "type": "function",
  20         "description": "Returns \"locked\" if the system is locked, \"idle\" if the user has not generated any input for a specified number of seconds, or \"active\" otherwise.",
  21         "parameters": [
  22           {
  23             "name": "detectionIntervalInSeconds",
  24             "type": "integer",
  25             "minimum": 15,
  26             "description": "The system is considered idle if detectionIntervalInSeconds seconds have elapsed since the last user input detected."
  27           },
  28           {
  29             "name": "callback",
  30             "type": "function",
  31             "parameters": [
  32               {
  33                 "name": "newState",
  34                 "$ref": "IdleState"
  35               }
  36             ]
  37           }
  38         ]
  39       },
  40       {
  41         "name": "setDetectionInterval",
  42         "type": "function",
  43         "description": "Sets the interval, in seconds, used to determine when the system is in an idle state for onStateChanged events. The default interval is 60 seconds.",
  44         "parameters": [
  45           {
  46             "name": "intervalInSeconds",
  47             "type": "integer",
  48             "minimum": 15,
  49             "description": "Threshold, in seconds, used to determine when the system is in an idle state."
  50           }
  51         ]
  52       }
  53     ],
  54     "events": [
  55       {
  56         "name": "onStateChanged",
  57         "type": "function",
  58         "description": "Fired when the system changes to an active, idle or locked state. The event fires with \"locked\" if the screen is locked or the screensaver activates, \"idle\" if the system is unlocked and the user has not generated any input for a specified number of seconds, and \"active\" when the user generates input on an idle system.",
  59         "parameters": [
  60           {
  61             "name": "newState",
  62             "$ref": "IdleState"
  63           }
  64         ]
  65       }
  66     ]
  67   }
  68 ]