Set the current composition. If this extension does not own the active IME, this fails. | Parameters | |---| | object | parameters | | integer | contextID | |---|---| ID of the context where the composition text will be set | | string | text | Text to set | | integer | (optional) selectionStart | Position in the text that the selection starts at. | | integer | (optional) selectionEnd | Position in the text that the selection ends at. | | integer | cursor | Position in the text of the cursor. | | array of object | (optional) segments | List of segments and their associated types. #### Properties of each object

| integer | start | |---|---| Index of the character to start this segment at | | integer | end | Index of the character to end this segment after. | | [UnderlineStyle](/extensions/input.ime#type-UnderlineStyle) | style | The type of the underline to modify this segment. |

| | | function | (optional) callback | Called when the operation completes with a boolean indicating if the text was accepted or not. On failure, whale.runtime.lastError is set. If you specify the _callback_ parameter, it should be a function that looks like this: `function(boolean success) {...};` | boolean | success | | |---|---|---| |

Clear the current composition. If this extension does not own the active IME, this fails. | Parameters | |---| | object | parameters | | integer | contextID | |---|---| ID of the context where the composition will be cleared | | | function | (optional) callback | Called when the operation completes with a boolean indicating if the text was accepted or not. On failure, whale.runtime.lastError is set. If you specify the _callback_ parameter, it should be a function that looks like this: `function(boolean success) {...};` | boolean | success | | |---|---|---| |

Commits the provided text to the current input. | Parameters | |---| | object | parameters | | integer | contextID | |---|---| ID of the context where the text will be committed | | string | text | The text to commit | | | function | (optional) callback | Called when the operation completes with a boolean indicating if the text was accepted or not. On failure, whale.runtime.lastError is set. If you specify the _callback_ parameter, it should be a function that looks like this: `function(boolean success) {...};` | boolean | success | | |---|---|---| |

Since Chrome 33. Sends the key events. This function is expected to be used by virtual keyboards. When key(s) on a virtual keyboard is pressed by a user, this function is used to propagate that event to the system. | Parameters | |---| | object | parameters | | integer | contextID | |---|---| ID of the context where the key events will be sent, or zero to send key events to non-input field. | | array of [KeyboardEvent](/extensions/input.ime#type-KeyboardEvent) | keyData | Data on the key event. | | | function | (optional) callback | Called when the operation completes. If you specify the _callback_ parameter, it should be a function that looks like this: `function() {...};` |

Since Chrome 34. Hides the input view window, which is popped up automatically by system. If the input view window is already hidden, this function will do nothing.

Sets the properties of the candidate window. This fails if the extension doesn't own the active IME | Parameters | |---| | object | parameters | | string | engineID | |---|---| ID of the engine to set properties on. | | object | properties | | boolean | (optional) visible | |---|---| True to show the Candidate window, false to hide it. | | boolean | (optional) cursorVisible | True to show the cursor, false to hide it. | | boolean | (optional) vertical | True if the candidate window should be rendered vertical, false to make it horizontal. | | integer | (optional) pageSize | The number of candidates to display per page. | | string | (optional) auxiliaryText | Text that is shown at the bottom of the candidate window. | | boolean | (optional) auxiliaryTextVisible | True to display the auxiliary text, false to hide it. | | [WindowPosition](/extensions/input.ime#type-WindowPosition) | (optional) windowPosition | Since Chrome 28. Where to display the candidate window. | | | | function | (optional) callback | Called when the operation completes. If you specify the _callback_ parameter, it should be a function that looks like this: `function(boolean success) {...};` | boolean | success | | |---|---|---| |

Sets the current candidate list. This fails if this extension doesn't own the active IME | Parameters | |---| | object | parameters | | integer | contextID | |---|---| ID of the context that owns the candidate window. | | array of object | candidates | List of candidates to show in the candidate window #### Properties of each object

| string | candidate | |---|---| The candidate | | integer | id | The candidate's id | | integer | (optional) parentId | The id to add these candidates under | | string | (optional) label | Short string displayed to next to the candidate, often the shortcut key or index | | string | (optional) annotation | Additional text describing the candidate | | object | (optional) usage | The usage or detail description of word. | string | title | |---|---| The title string of details description. | | string | body | The body string of detail description. | |

| | | function | (optional) callback | Called when the operation completes. If you specify the _callback_ parameter, it should be a function that looks like this: `function(boolean success) {...};` | boolean | success | | |---|---|---| |

Set the position of the cursor in the candidate window. This is a no-op if this extension does not own the active IME. | Parameters | |---| | object | parameters | | integer | contextID | |---|---| ID of the context that owns the candidate window. | | integer | candidateID | ID of the candidate to select. | | | function | (optional) callback | Called when the operation completes If you specify the _callback_ parameter, it should be a function that looks like this: `function(boolean success) {...};` | boolean | success | | |---|---|---| |

Adds the provided menu items to the language menu when this IME is active. | Parameters | |---| | object | parameters | | string | engineID | |---|---| ID of the engine to use | | array of [MenuItem](/extensions/input.ime#type-MenuItem) | items | MenuItems to add. They will be added in the order they exist in the array. | | | function | (optional) callback | If you specify the _callback_ parameter, it should be a function that looks like this: `function() {...};` |

Updates the state of the MenuItems specified | Parameters | |---| | object | parameters | | string | engineID | |---|---| ID of the engine to use | | array of [MenuItem](/extensions/input.ime#type-MenuItem) | items | Array of MenuItems to update | | | function | (optional) callback | Called when the operation completes If you specify the _callback_ parameter, it should be a function that looks like this: `function() {...};` |

Since Chrome 27. Deletes the text around the caret. | Parameters | |---| | object | parameters | | string | engineID | |---|---| ID of the engine receiving the event. | | integer | contextID | ID of the context where the surrounding text will be deleted. | | integer | offset | The offset from the caret position where deletion will start. This value can be negative. | | integer | length | The number of characters to be deleted | | | function | (optional) callback | Called when the operation completes. If you specify the _callback_ parameter, it should be a function that looks like this: `function() {...};` |

Since Chrome 25. Indicates that the key event received by onKeyEvent is handled. This should only be called if the onKeyEvent listener is asynchronous. | Parameters | |---| | string | requestId | Request id of the event that was handled. This should come from keyEvent.requestId | | boolean | response | True if the keystroke was handled, false if not |

Since Chrome 50. Creates IME window. | Parameters | |---| | [CreateWindowOptions](/extensions/input.ime#type-CreateWindowOptions) | options | The options of the newly created IME window. | | function | callback | Called when the operation completes. The _callback_ parameter should be a function that looks like this: `function(Window windowObject) {...};` | Window | windowObject | |---|---| The JavaScript 'window' object of the newly created IME window. It contains the additional 'id' property for the parameters of the other functions like showWindow/hideWindow. | |

Since Chrome 51. Shows the IME window. This makes the hidden window visible. | Parameters | |---| | integer | windowId | The ID of the IME window. | | function | (optional) callback | Called when the operation completes. If you specify the _callback_ parameter, it should be a function that looks like this: `function() {...};` |

Since Chrome 51. Hides the IME window. This doesn't close the window. Instead, it makes the window invisible. The extension can cache the window and show/hide it for better performance. | Parameters | |---| | integer | windowId | The ID of the IME window. | | function | (optional) callback | Called when the operation completes. If you specify the _callback_ parameter, it should be a function that looks like this: `function() {...};` |

Since Chrome 50. Activates the IME extension so that it can receive events. | Parameters | |---| | function | (optional) callback | Called when the operation completes. If you specify the _callback_ parameter, it should be a function that looks like this: `function() {...};` |

Since Chrome 50. Deactivates the IME extension so that it cannot receive events. | Parameters | |---| | function | (optional) callback | Called when the operation completes. If you specify the _callback_ parameter, it should be a function that looks like this: `function() {...};` |

This event is sent when an IME is activated. It signals that the IME will be receiving onKeyPress events.

This event is sent when an IME is deactivated. It signals that the IME will no longer be receiving onKeyPress events.

This event is sent when focus enters a text box. It is sent to all extensions that are listening to this event, and enabled by the user.

This event is sent when focus leaves a text box. It is sent to all extensions that are listening to this event, and enabled by the user.

This event is sent when the properties of the current InputContext change, such as the the type. It is sent to all extensions that are listening to this event, and enabled by the user.

Fired when a key event is sent from the operating system. The event will be sent to the extension if this extension owns the active IME.

This event is sent if this extension owns the active IME.

Called when the user selects a menu item

Since Chrome 27. Called when the editable string around caret is changed or when the caret position is moved. The text length is limited to 100 characters for each back and forth direction.

Since Chrome 29. This event is sent when chrome terminates ongoing text input session.

Since Chrome 50. Triggered when the bounds of the IME composition text or cursor are changed. The IME composition text is the instance of text produced in the input method editor.