chrome/common/extensions/api/input_method_private.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": "inputMethodPrivate",
   8     "platforms": ["chromeos"],
   9     "description": "none",
  10     "functions": [
  11       {
  12         "name": "getInputMethodConfig",
  13         "type": "function",
  14         "description": "Gets configurations for input methods.",
  15         "parameters": [
  16           {
  17             "name": "callback",
  18             "type": "function",
  19             "optional": false,
  20             "description": "Callback which is called with the config object.",
  21             "parameters": [
  22               {
  23                 "name": "config",
  24                 "type": "object",
  25                 "description": "The input method config object.",
  26                 "properties": {
  27                   "isPhysicalKeyboardAutocorrectEnabled": {"type": "boolean"}
  28                 }
  29               }
  30             ]
  31           }
  32         ]
  33       }, {
  34         "name": "getInputMethods",
  35         "type": "function",
  36         "description": "Gets all whitelisted input methods.",
  37         "parameters": [
  38           {
  39             "name": "callback",
  40             "type": "function",
  41             "optional": false,
  42             "description": "Callback which is called with the input method objects.",
  43             "parameters": [
  44               {
  45                 "name": "inputMethods",
  46                 "type": "array",
  47                 "description": "Whitelisted input method objects.",
  48                 "items": {
  49                   "type": "object",
  50                   "properties": {
  51                     "id": {"type": "string"},
  52                     "name": {"type": "string"},
  53                     "indicator": {"type": "string"}
  54                   }
  55                 }
  56               }
  57             ]
  58           }
  59         ]
  60       }, {
  61         "name": "getCurrentInputMethod",
  62         "type": "function",
  63         "description": "Gets the current input method.",
  64         "parameters": [
  65           {
  66             "name": "callback",
  67             "type": "function",
  68             "optional": false,
  69             "description": "Callback which is called with the current input method.",
  70             "parameters": [
  71               {
  72                 "name": "inputMethodId",
  73                 "type": "string",
  74                 "description": "Current input method."
  75               }
  76             ]
  77           }
  78         ]
  79       }, {
  80         "name": "setCurrentInputMethod",
  81         "type": "function",
  82         "description": "Sets the current input method.",
  83         "parameters": [
  84           {
  85             "name": "inputMethodId",
  86             "type": "string",
  87             "optional": false,
  88             "description": "The input method ID to be set as current input method."
  89           },
  90           {
  91             "name": "callback",
  92             "type": "function",
  93             "optional": true,
  94             "description": "Callback which is called once the current input method is set or error occurs.",
  95             "parameters": []
  96           }
  97         ]
  98       }
  99     ],
 100     "events": [
 101       {
 102         "name": "onChanged",
 103         "type": "function",
 104         "description": "Fired when the input method is changed.",
 105         "parameters": [
 106           {
 107             "name": "newInputMethodId",
 108             "type": "string",
 109             "description": "New input method which is being used."
 110           }
 111         ]
 112       }, {
 113         "name": "onCompositionBoundsChanged",
 114         "type": "function",
 115         "description": "Fired when the composition bounds are changed.",
 116         "parameters": [
 117           {
 118             "name": "bounds",
 119             "type": "object",
 120             "description": "Composition bounds.",
 121             "properties": {
 122               "x": {"type": "integer"},
 123               "y": {"type": "integer"},
 124               "w": {"type": "integer"},
 125               "h": {"type": "integer"}
 126             }
 127           }
 128         ]
 129       }
 130     ]
 131   }
 132 ]