Added in API level 3

InputMethodManager

---

Kotlin |Java

class InputMethodManager

kotlin.Any
↳	android.view.inputmethod.InputMethodManager

Central system API to the overall input method framework (IMF) architecture, which arbitrates interaction between applications and the current input method.

Topics covered here:

1. Architecture Overview
2. Applications
3. Input Methods
4. Security

Architecture Overview

There are three primary parties involved in the input method framework (IMF) architecture:

• The input method manager as expressed by this class is the central point of the system that manages interaction between all other parts. It is expressed as the client-side API here which exists in each application context and communicates with a global system service that manages the interaction across all processes.
• An input method (IME) implements a particular interaction model allowing the user to generate text. The system binds to the current input method that is in use, causing it to be created and run, and tells it when to hide and show its UI. Only one IME is running at a time.
• Multiple client applications arbitrate with the input method manager for input focus and control over the state of the IME. Only one such client is ever active (working with the IME) at a time.

Applications

In most cases, applications that are using the standard android.widget.TextView or its subclasses will have little they need to do to work well with soft input methods. The main things you need to be aware of are:

• Properly set the android.R.attr#inputType in your editable text views, so that the input method will have enough context to help the user in entering text into them.
• Deal well with losing screen space when the input method is displayed. Ideally an application should handle its window being resized smaller, but it can rely on the system performing panning of the window if needed. You should set the android.R.attr#windowSoftInputMode attribute on your activity or the corresponding values on windows you create to help the system determine whether to pan or resize (it will try to determine this automatically but may get it wrong).
• You can also control the preferred soft input state (open, closed, etc) for your window using the same android.R.attr#windowSoftInputMode attribute.

More finer-grained control is available through the APIs here to directly interact with the IMF and its IME -- either showing or hiding the input area, letting the user pick an input method, etc.

For the rare people amongst us writing their own text editors, you will need to implement android.view.View#onCreateInputConnection to return a new instance of your own InputConnection interface allowing the IME to interact with your editor.

Input Methods

An input method (IME) is implemented as a android.app.Service, typically deriving from android.inputmethodservice.InputMethodService. It must provide the core InputMethod interface, though this is normally handled by android.inputmethodservice.InputMethodService and implementors will only need to deal with the higher-level API there.

See the android.inputmethodservice.InputMethodService class for more information on implementing IMEs.

Security

There are a lot of security issues associated with input methods, since they essentially have freedom to completely drive the UI and monitor everything the user enters. The Android input method framework also allows arbitrary third party IMEs, so care must be taken to restrict their selection and interactions.

Here are some key points about the security architecture behind the IMF:

• Only the system is allowed to directly access an IME's InputMethod interface, via the android.Manifest.permission#BIND_INPUT_METHOD permission. This is enforced in the system by not binding to an input method service that does not require this permission, so the system can guarantee no other untrusted clients are accessing the current input method outside of its control.

• There may be many client processes of the IMF, but only one may be active at a time. The inactive clients can not interact with key parts of the IMF through the mechanisms described below.

• Clients of an input method are only given access to its InputMethodSession interface. One instance of this interface is created for each client, and only calls from the session associated with the active client will be processed by the current IME. This is enforced by android.inputmethodservice.AbstractInputMethodService for normal IMEs, but must be explicitly handled by an IME that is customizing the raw InputMethodSession implementation.

• Only the active client's InputConnection will accept operations. The IMF tells each client process whether it is active, and the framework enforces that in inactive processes calls on to the current InputConnection will be ignored. This ensures that the current IME can only deliver events and text edits to the UI that the user sees as being in focus.

• An IME can never interact with an InputConnection while the screen is off. This is enforced by making all clients inactive while the screen is off, and prevents bad IMEs from driving the UI when the user can not be aware of its behavior.

• A client application can ask that the system let the user pick a new IME, but can not programmatically switch to one itself. This avoids malicious applications from switching the user to their own IME, which remains running when the user navigates away to another application. An IME, on the other hand, is allowed to programmatically switch the system to another IME, since it already has full control of user input.

• The user must explicitly enable a new IME in settings before they can switch to it, to confirm with the system that they know about it and want to make it available for use.

If your app targets Android 11 (API level 30) or higher, the methods in this class each return a filtered result by the rules of package visibility, except for the currently connected IME. Apps having a query for the InputMethod.SERVICE_INTERFACE see all IMEs.

Requires the PackageManager#FEATURE_INPUT_METHODS feature which can be detected using PackageManager.hasSystemFeature(String).

Summary

Constants
static Int	HANDWRITING_DELEGATE_FLAG_HOME_DELEGATOR_ALLOWED Flag indicating that views from the default home screen (Intent.CATEGORY_HOME) may act as a handwriting delegator for the delegate editor view.
static Int	HIDE_IMPLICIT_ONLY Flag for #hideSoftInputFromWindow and InputMethodService.requestHideSelf(int) to indicate that the soft input window should only be hidden if it was not explicitly shown by the user.
static Int	HIDE_NOT_ALWAYS Flag for #hideSoftInputFromWindow and InputMethodService.requestShowSelf(int) to indicate that the soft input window should normally be hidden, unless it was originally shown with SHOW_FORCED.
static Int	RESULT_HIDDEN Flag for the ResultReceiver result code from showSoftInput(android.view.View,int,android.os.ResultReceiver) and hideSoftInputFromWindow(android.os.IBinder,int,android.os.ResultReceiver): the state of the soft input window changed from shown to hidden.
static Int	RESULT_SHOWN Flag for the ResultReceiver result code from showSoftInput(android.view.View,int,android.os.ResultReceiver) and hideSoftInputFromWindow(android.os.IBinder,int,android.os.ResultReceiver): the state of the soft input window changed from hidden to shown.
static Int	RESULT_UNCHANGED_HIDDEN Flag for the ResultReceiver result code from showSoftInput(android.view.View,int,android.os.ResultReceiver) and hideSoftInputFromWindow(android.os.IBinder,int,android.os.ResultReceiver): the state of the soft input window was unchanged and remains hidden.
static Int	RESULT_UNCHANGED_SHOWN Flag for the ResultReceiver result code from showSoftInput(android.view.View,int,android.os.ResultReceiver) and hideSoftInputFromWindow(android.os.IBinder,int,android.os.ResultReceiver): the state of the soft input window was unchanged and remains shown.
static Int	SHOW_FORCED Flag for #showSoftInput to indicate that the user has forced the input method open (such as by long-pressing menu) so it should not be closed until they explicitly do so.
static Int	SHOW_IMPLICIT Flag for #showSoftInput to indicate that this is an implicit request to show the input window, not as the result of a direct request by the user.

Public methods
Boolean	acceptStylusHandwritingDelegation(delegateView: View) Accepts and starts a stylus handwriting session on the delegate view, if handwriting initiation delegation was previously requested using prepareStylusHandwritingDelegation(android.view.View) from the delegator.
Boolean	acceptStylusHandwritingDelegation(delegateView: View, delegatorPackageName: String) Accepts and starts a stylus handwriting session on the delegate view, if handwriting initiation delegation was previously requested using prepareStylusHandwritingDelegation(android.view.View,java.lang.String) from the delegator and the view belongs to a specified delegate package.
Unit	acceptStylusHandwritingDelegation(delegateView: View, delegatorPackageName: String, flags: Int, executor: Executor, callback: Consumer<Boolean!>) Accepts and starts a stylus handwriting session on the delegate view, if handwriting initiation delegation was previously requested using prepareStylusHandwritingDelegation(android.view.View,java.lang.String) from the delegator and the view belongs to a specified delegate package.
Unit	acceptStylusHandwritingDelegation(delegateView: View, delegatorPackageName: String, executor: Executor, callback: Consumer<Boolean!>) Accepts and starts a stylus handwriting session on the delegate view, if handwriting initiation delegation was previously requested using prepareStylusHandwritingDelegation(android.view.View,java.lang.String) from the delegator and the view belongs to a specified delegate package.
Unit	dispatchKeyEventFromInputMethod(targetView: View?, event: KeyEvent) Provides the default implementation of InputConnection.sendKeyEvent(KeyEvent), which is expected to dispatch an keyboard event sent from the IME to an appropriate event target depending on the given View and the current focus state.
Unit	displayCompletions(view: View!, completions: Array<CompletionInfo!>!)
InputMethodInfo?	getCurrentInputMethodInfo() Returns the InputMethodInfo of the currently selected input method (for the process's user).
InputMethodSubtype?	getCurrentInputMethodSubtype() Returns the current input method subtype.
MutableList<InputMethodInfo!>	getEnabledInputMethodList() Returns the list of enabled input methods.
MutableList<InputMethodSubtype!>	getEnabledInputMethodSubtypeList(imi: InputMethodInfo?, allowsImplicitlyEnabledSubtypes: Boolean) Returns a list of enabled input method subtypes for the specified input method info.
MutableList<InputMethodInfo!>	getInputMethodList() Returns the list of installed input methods.
InputMethodSubtype?	getLastInputMethodSubtype() Returns the last used InputMethodSubtype in system history.
MutableMap<InputMethodInfo!, MutableList<InputMethodSubtype!>!>!	getShortcutInputMethodsAndSubtypes() Returns a map of all shortcut input method info and their subtypes.
Unit	hideSoftInputFromInputMethod(token: IBinder!, flags: Int) Close/hide the input method's soft input area, so the user no longer sees it or can interact with it.
Boolean	hideSoftInputFromWindow(windowToken: IBinder!, flags: Int) Synonym for hideSoftInputFromWindow(android.os.IBinder,int,android.os.ResultReceiver) without a result: request to hide the soft input window from the context of the window that is currently accepting input.
Boolean	hideSoftInputFromWindow(windowToken: IBinder!, flags: Int, resultReceiver: ResultReceiver!) Request to hide the soft input window from the context of the window that is currently accepting input.
Unit	hideStatusIcon(imeToken: IBinder!)
Unit	invalidateInput(view: View) Gives a hint to the system that the text associated with view is updated by something that is not an input method editor (IME), so that the system can cancel any pending text editing requests from the IME until it receives the new editing context such as surrounding text provided by InputConnection.takeSnapshot().
Boolean	isAcceptingText() Return true if the currently served view is accepting full text edits.
Boolean	isActive() Return true if any view is currently active for the input method.
Boolean	isActive(view: View!) Return true if the given view is the currently active view for the input method.
Boolean	isConnectionlessStylusHandwritingAvailable() Returns true if the currently selected IME supports connectionless stylus handwriting sessions and is enabled.
Boolean	isFullscreenMode() Allows you to discover whether the attached input method is running in fullscreen mode.
Boolean	isInputMethodSuppressingSpellChecker() Return true if the input method is suppressing system spell checker.
Boolean	isStylusHandwritingAvailable() Returns true if currently selected IME supports Stylus handwriting & is enabled.
Boolean	isWatchingCursor(view: View!) Return true if the current input method wants to watch the location of the input editor's cursor in its window.
Unit	prepareStylusHandwritingDelegation(delegatorView: View) Prepares delegation of starting stylus handwriting session to a different editor in same or different window than the view on which initial handwriting stroke was detected.
Unit	prepareStylusHandwritingDelegation(delegatorView: View, delegatePackageName: String) Prepares delegation of starting stylus handwriting session to a different editor in same or a different window in a different package than the view on which initial handwriting stroke was detected.
Unit	restartInput(view: View!) If the input method is currently connected to the given view, restart it with its new contents.
Unit	sendAppPrivateCommand(view: View!, action: String!, data: Bundle!) Call InputMethodSession.appPrivateCommand() on the current Input Method.
Unit	setAdditionalInputMethodSubtypes(imiId: String, subtypes: Array<InputMethodSubtype!>) Set additional input method subtypes.
Boolean	setCurrentInputMethodSubtype(subtype: InputMethodSubtype!) Switch to a new input method subtype of the current input method.
Unit	setExplicitlyEnabledInputMethodSubtypes(imiId: String, subtypeHashCodes: IntArray) Updates the list of explicitly enabled InputMethodSubtype for a given IME owned by the calling process.
Unit	setInputMethod(token: IBinder!, id: String!) Force switch to a new input method component.
Unit	setInputMethodAndSubtype(token: IBinder, id: String!, subtype: InputMethodSubtype!) Force switch to a new input method and subtype.
Boolean	shouldOfferSwitchingToNextInputMethod(imeToken: IBinder!) Returns true if the current IME needs to offer the users ways to switch to a next input method (e.g. a globe key.).
Unit	showInputMethodAndSubtypeEnabler(imiId: String?) Show the settings for enabling subtypes of the specified input method.
Unit	showInputMethodPicker() Show IME picker popup window.
Boolean	showSoftInput(view: View!, flags: Int) Synonym for showSoftInput(android.view.View,int,android.os.ResultReceiver) without a result receiver: explicitly request that the current input method's soft input area be shown to the user, if needed.
Boolean	showSoftInput(view: View!, flags: Int, resultReceiver: ResultReceiver!) Explicitly request that the current input method's soft input area be shown to the user, if needed.
Unit	showSoftInputFromInputMethod(token: IBinder!, flags: Int) Show the input method's soft input area, so the user sees the input method window and can interact with it.
Unit	showStatusIcon(imeToken: IBinder!, packageName: String!, iconId: Int)
Unit	startConnectionlessStylusHandwriting(view: View, cursorAnchorInfo: CursorAnchorInfo?, callbackExecutor: Executor, callback: ConnectionlessHandwritingCallback) Starts a connectionless stylus handwriting session.
Unit	startConnectionlessStylusHandwritingForDelegation(delegatorView: View, cursorAnchorInfo: CursorAnchorInfo?, delegatePackageName: String, callbackExecutor: Executor, callback: ConnectionlessHandwritingCallback) Starts a connectionless stylus handwriting session (see startConnectionlessStylusHandwriting) and additionally enables the recognised handwritten text to be later committed to a text editor using acceptStylusHandwritingDelegation(android.view.View,java.lang.String).
Unit	startConnectionlessStylusHandwritingForDelegation(delegatorView: View, cursorAnchorInfo: CursorAnchorInfo?, callbackExecutor: Executor, callback: ConnectionlessHandwritingCallback) Starts a connectionless stylus handwriting session (see startConnectionlessStylusHandwriting) and additionally enables the recognised handwritten text to be later committed to a text editor using acceptStylusHandwritingDelegation(android.view.View).
Unit	startStylusHandwriting(view: View) Start stylus handwriting session.
Boolean	switchToLastInputMethod(imeToken: IBinder!) Force switch to the last used input method and subtype.
Boolean	switchToNextInputMethod(imeToken: IBinder!, onlyCurrentIme: Boolean) Force switch to the next input method and subtype.
Unit	toggleSoftInput(showFlags: Int, hideFlags: Int) This method toggles the input method window display.
Unit	toggleSoftInputFromWindow(windowToken: IBinder!, showFlags: Int, hideFlags: Int) This method toggles the input method window display.
Unit	updateCursor(view: View!, left: Int, top: Int, right: Int, bottom: Int) Report the current cursor location in its window.
Unit	updateCursorAnchorInfo(view: View!, cursorAnchorInfo: CursorAnchorInfo!) Report positional change of the text insertion point and/or characters in the composition string.
Unit	updateExtractedText(view: View!, token: Int, text: ExtractedText!)
Unit	updateSelection(view: View!, selStart: Int, selEnd: Int, candidatesStart: Int, candidatesEnd: Int) Report the current selection range.
Unit	viewClicked(view: View!) Notify the event when the user tapped or clicked the text view.

Constants

HANDWRITING_DELEGATE_FLAG_HOME_DELEGATOR_ALLOWED

Added in API level 35

static val HANDWRITING_DELEGATE_FLAG_HOME_DELEGATOR_ALLOWED: Int

Flag indicating that views from the default home screen (Intent.CATEGORY_HOME) may act as a handwriting delegator for the delegate editor view. If set, views from the home screen package will be trusted for handwriting delegation, in addition to views in the delegatorPackageName passed to acceptStylusHandwritingDelegation(android.view.View,java.lang.String,int,java.util.concurrent.Executor,java.util.function.Consumer) .

Value: 1

HIDE_IMPLICIT_ONLY

Added in API level 3

static val HIDE_IMPLICIT_ONLY: Int

Flag for #hideSoftInputFromWindow and InputMethodService.requestHideSelf(int) to indicate that the soft input window should only be hidden if it was not explicitly shown by the user.

Value: 1

HIDE_NOT_ALWAYS

Added in API level 3

static val HIDE_NOT_ALWAYS: Int

Flag for #hideSoftInputFromWindow and InputMethodService.requestShowSelf(int) to indicate that the soft input window should normally be hidden, unless it was originally shown with SHOW_FORCED.

Value: 2

RESULT_HIDDEN

Added in API level 3

static val RESULT_HIDDEN: Int

Flag for the ResultReceiver result code from showSoftInput(android.view.View,int,android.os.ResultReceiver) and hideSoftInputFromWindow(android.os.IBinder,int,android.os.ResultReceiver): the state of the soft input window changed from shown to hidden.

Value: 3

RESULT_SHOWN

Added in API level 3

static val RESULT_SHOWN: Int

Flag for the ResultReceiver result code from showSoftInput(android.view.View,int,android.os.ResultReceiver) and hideSoftInputFromWindow(android.os.IBinder,int,android.os.ResultReceiver): the state of the soft input window changed from hidden to shown.

Value: 2

RESULT_UNCHANGED_HIDDEN

Added in API level 3

static val RESULT_UNCHANGED_HIDDEN: Int

Flag for the ResultReceiver result code from showSoftInput(android.view.View,int,android.os.ResultReceiver) and hideSoftInputFromWindow(android.os.IBinder,int,android.os.ResultReceiver): the state of the soft input window was unchanged and remains hidden.

Value: 1

RESULT_UNCHANGED_SHOWN

Added in API level 3

static val RESULT_UNCHANGED_SHOWN: Int

Flag for the ResultReceiver result code from showSoftInput(android.view.View,int,android.os.ResultReceiver) and hideSoftInputFromWindow(android.os.IBinder,int,android.os.ResultReceiver): the state of the soft input window was unchanged and remains shown.

Value: 0

SHOW_FORCED

Added in API level 3
Deprecated in API level 33

static val SHOW_FORCED: Int

Deprecated: Use #showSoftInput without this flag instead. Using this flag can lead to the soft input remaining visible even when the calling application is closed. The use of this flag can make the soft input remain visible globally. Starting in Android T, this flag only has an effect while the caller is currently focused.

Flag for #showSoftInput to indicate that the user has forced the input method open (such as by long-pressing menu) so it should not be closed until they explicitly do so.

Value: 2

SHOW_IMPLICIT

Added in API level 3

static val SHOW_IMPLICIT: Int

Flag for #showSoftInput to indicate that this is an implicit request to show the input window, not as the result of a direct request by the user. The window may not be shown in this case.

Value: 1

Public methods

acceptStylusHandwritingDelegation

Added in API level 34

fun acceptStylusHandwritingDelegation(delegateView: View): Boolean

Accepts and starts a stylus handwriting session on the delegate view, if handwriting initiation delegation was previously requested using prepareStylusHandwritingDelegation(android.view.View) from the delegator.

Otherwise, if the delegator view previously started delegation using startConnectionlessStylusHandwritingForDelegation(android.view.View,android.view.inputmethod.CursorAnchorInfo,java.util.concurrent.Executor,android.view.inputmethod.ConnectionlessHandwritingCallback), requests the IME to commit the recognised handwritten text from the connectionless session to the delegate view.

Note: If delegator and delegate are in different application packages, use acceptStylusHandwritingDelegation(android.view.View,java.lang.String) instead.

Parameters
delegateView	View: delegate view capable of receiving input via InputConnection This value cannot be null.

Return
Boolean	true if view belongs to same application package as used in prepareStylusHandwritingDelegation(android.view.View) and delegation is accepted

See Also

• #prepareStylusHandwritingDelegation(View)
• #acceptStylusHandwritingDelegation(View, String)
• #startConnectionlessStylusHandwritingForDelegation(View, CursorAnchorInfo, Executor, * ConnectionlessHandwritingCallback)

acceptStylusHandwritingDelegation

Added in API level 34

fun acceptStylusHandwritingDelegation(
    delegateView: View, 
    delegatorPackageName: String
): Boolean

Accepts and starts a stylus handwriting session on the delegate view, if handwriting initiation delegation was previously requested using prepareStylusHandwritingDelegation(android.view.View,java.lang.String) from the delegator and the view belongs to a specified delegate package.

Otherwise, if the delegator view previously started delegation using startConnectionlessStylusHandwritingForDelegation(android.view.View,android.view.inputmethod.CursorAnchorInfo,java.lang.String,java.util.concurrent.Executor,android.view.inputmethod.ConnectionlessHandwritingCallback), requests the IME to commit the recognised handwritten text from the connectionless session to the delegate view.

Note: If delegator and delegate are in the same application package, use acceptStylusHandwritingDelegation(android.view.View) instead.

Parameters
delegateView	View: delegate view capable of receiving input via InputConnection This value cannot be null.
delegatorPackageName	String: package name of the delegator that handled initial stylus stroke. This value cannot be null.

Return
Boolean	true if view belongs to allowed delegate package declared in prepareStylusHandwritingDelegation(android.view.View,java.lang.String) and delegation is accepted

See Also

• #prepareStylusHandwritingDelegation(View, String)
• #acceptStylusHandwritingDelegation(View)
• #startConnectionlessStylusHandwritingForDelegation(View, CursorAnchorInfo, String, * Executor, ConnectionlessHandwritingCallback)

acceptStylusHandwritingDelegation

Added in API level 35

fun acceptStylusHandwritingDelegation(
    delegateView: View, 
    delegatorPackageName: String, 
    flags: Int, 
    executor: Executor, 
    callback: Consumer<Boolean!>
): Unit

Accepts and starts a stylus handwriting session on the delegate view, if handwriting initiation delegation was previously requested using prepareStylusHandwritingDelegation(android.view.View,java.lang.String) from the delegator and the view belongs to a specified delegate package.

Otherwise, if the delegator view previously started delegation using startConnectionlessStylusHandwritingForDelegation(android.view.View,android.view.inputmethod.CursorAnchorInfo,java.lang.String,java.util.concurrent.Executor,android.view.inputmethod.ConnectionlessHandwritingCallback), requests the IME to commit the recognised handwritten text from the connectionless session to the delegate view.

Note: If delegator and delegate are in the same application package, use acceptStylusHandwritingDelegation(android.view.View) instead.

Parameters
delegateView	View: delegate view capable of receiving input via InputConnection This value cannot be null.
delegatorPackageName	String: package name of the delegator that handled initial stylus stroke. This value cannot be null.
flags	Int: HANDWRITING_DELEGATE_FLAG_HOME_DELEGATOR_ALLOWED or 0 Value is either 0 or android.view.inputmethod.InputMethodManager#HANDWRITING_DELEGATE_FLAG_HOME_DELEGATOR_ALLOWED
executor	Executor: The executor to run the callback on. This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread.
callback	Consumer<Boolean!>: true would be received if delegation was accepted. The caller should hold a reference to the callback. The framework only holds a weak reference. This value cannot be null.

See Also

• #prepareStylusHandwritingDelegation(View, String)
• #acceptStylusHandwritingDelegation(View)
• #startConnectionlessStylusHandwritingForDelegation(View, CursorAnchorInfo, String, * Executor, ConnectionlessHandwritingCallback)

acceptStylusHandwritingDelegation

Added in API level 35

fun acceptStylusHandwritingDelegation(
    delegateView: View, 
    delegatorPackageName: String, 
    executor: Executor, 
    callback: Consumer<Boolean!>
): Unit

Accepts and starts a stylus handwriting session on the delegate view, if handwriting initiation delegation was previously requested using prepareStylusHandwritingDelegation(android.view.View,java.lang.String) from the delegator and the view belongs to a specified delegate package.

Otherwise, if the delegator view previously started delegation using startConnectionlessStylusHandwritingForDelegation(android.view.View,android.view.inputmethod.CursorAnchorInfo,java.lang.String,java.util.concurrent.Executor,android.view.inputmethod.ConnectionlessHandwritingCallback), requests the IME to commit the recognised handwritten text from the connectionless session to the delegate view.

Parameters
delegateView	View: delegate view capable of receiving input via InputConnection on which startStylusHandwriting(android.view.View) will be called. This value cannot be null.
delegatorPackageName	String: package name of the delegator that handled initial stylus stroke. This value cannot be null.
executor	Executor: The executor to run the callback on. This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread.
callback	Consumer<Boolean!>: Consumer callback that provides true if view belongs to allowed delegate package declared in prepareStylusHandwritingDelegation(android.view.View,java.lang.String) and handwriting session can start. Note: The caller should hold a reference to the callback. The framework only holds a weak reference. This value cannot be null.

See Also

• #prepareStylusHandwritingDelegation(View, String)
• #acceptStylusHandwritingDelegation(View)
• #startConnectionlessStylusHandwritingForDelegation(View, CursorAnchorInfo, String, * Executor, ConnectionlessHandwritingCallback)

dispatchKeyEventFromInputMethod

Added in API level 24

fun dispatchKeyEventFromInputMethod(
    targetView: View?, 
    event: KeyEvent
): Unit

Provides the default implementation of InputConnection.sendKeyEvent(KeyEvent), which is expected to dispatch an keyboard event sent from the IME to an appropriate event target depending on the given View and the current focus state.

CAUTION: This method is provided only for the situation where InputConnection.sendKeyEvent(KeyEvent) needs to be implemented without relying on BaseInputConnection. Do not use this API for anything else.

Parameters
targetView	View?: the default target view. If null is specified, then this method tries to find a good event target based on the current focus state.
event	KeyEvent: the key event to be dispatched. This value cannot be null.

displayCompletions

Added in API level 3

fun displayCompletions(
    view: View!, 
    completions: Array<CompletionInfo!>!
): Unit

getCurrentInputMethodInfo

Added in API level 34

fun getCurrentInputMethodInfo(): InputMethodInfo?

Returns the InputMethodInfo of the currently selected input method (for the process's user).

On multi user environment, this API returns a result for the calling process user.

Return
InputMethodInfo?	This value may be null.

getCurrentInputMethodSubtype

Added in API level 11

fun getCurrentInputMethodSubtype(): InputMethodSubtype?

Returns the current input method subtype. This subtype is one of the subtypes in the current input method. This method returns null when the current input method doesn't have any input method subtype.

getEnabledInputMethodList

Added in API level 3

fun getEnabledInputMethodList(): MutableList<InputMethodInfo!>

Returns the list of enabled input methods.

On multi user environment, this API returns a result for the calling process user.

Return
MutableList<InputMethodInfo!>	List of InputMethodInfo. This value cannot be null.

getEnabledInputMethodSubtypeList

Added in API level 11

fun getEnabledInputMethodSubtypeList(
    imi: InputMethodInfo?, 
    allowsImplicitlyEnabledSubtypes: Boolean
): MutableList<InputMethodSubtype!>

Returns a list of enabled input method subtypes for the specified input method info.

On multi user environment, this API returns a result for the calling process user.

Parameters
imi	InputMethodInfo?: The InputMethodInfo whose subtypes list will be returned. If null, returns enabled subtypes for the currently selected InputMethodInfo.
allowsImplicitlyEnabledSubtypes	Boolean: A boolean flag to allow to return the implicitly enabled subtypes. If an input method info doesn't have enabled subtypes, the framework will implicitly enable subtypes according to the current system language.

Return
MutableList<InputMethodSubtype!>	This value cannot be null.

getInputMethodList

Added in API level 3

fun getInputMethodList(): MutableList<InputMethodInfo!>

Returns the list of installed input methods.

On multi user environment, this API returns a result for the calling process user.

Return
MutableList<InputMethodInfo!>	List of InputMethodInfo. This value cannot be null.

getLastInputMethodSubtype

Added in API level 14

fun getLastInputMethodSubtype(): InputMethodSubtype?

Returns the last used InputMethodSubtype in system history.

Return
InputMethodSubtype?	the last InputMethodSubtype, null if last IME have no subtype.

getShortcutInputMethodsAndSubtypes

Added in API level 11

fun getShortcutInputMethodsAndSubtypes(): MutableMap<InputMethodInfo!, MutableList<InputMethodSubtype!>!>!

Returns a map of all shortcut input method info and their subtypes.

hideSoftInputFromInputMethod

Added in API level 3
Deprecated in API level 28

fun hideSoftInputFromInputMethod(
    token: IBinder!, 
    flags: Int
): Unit

Deprecated: Use InputMethodService.requestHideSelf(int) instead. This method was intended for IME developers who should be accessing APIs through the service. APIs in this class are intended for app developers interacting with the IME.

Close/hide the input method's soft input area, so the user no longer sees it or can interact with it. This can only be called from the currently active input method, as validated by the given token.

Parameters
token	IBinder!: Supplies the identifying token given to an input method when it was started, which allows it to perform this operation on itself.
flags	Int: Value is either 0 or a combination of android.view.inputmethod.InputMethodManager#HIDE_IMPLICIT_ONLY, and android.view.inputmethod.InputMethodManager#HIDE_NOT_ALWAYS

hideSoftInputFromWindow

Added in API level 3

fun hideSoftInputFromWindow(
    windowToken: IBinder!, 
    flags: Int
): Boolean

Synonym for hideSoftInputFromWindow(android.os.IBinder,int,android.os.ResultReceiver) without a result: request to hide the soft input window from the context of the window that is currently accepting input.

Parameters
windowToken	IBinder!: The token of the window that is making the request, as returned by View.getWindowToken().
flags	Int: Value is either 0 or a combination of android.view.inputmethod.InputMethodManager#HIDE_IMPLICIT_ONLY, and android.view.inputmethod.InputMethodManager#HIDE_NOT_ALWAYS

Return
Boolean	true if a request was sent to system_server, false otherwise. Note: this does not return result of the request. For result use ResultReceiver in hideSoftInputFromWindow(android.os.IBinder,int,android.os.ResultReceiver) instead.

hideSoftInputFromWindow

Added in API level 3
Deprecated in API level Baklava

fun hideSoftInputFromWindow(
    windowToken: IBinder!, 
    flags: Int, 
    resultReceiver: ResultReceiver!
): Boolean

Deprecated: The ResultReceiver is not a reliable way of determining whether the Input Method is actually shown or hidden. If result is needed, use android.view.WindowInsetsController#hide instead and set a View.OnApplyWindowInsetsListener and verify the provided WindowInsets for the visibility of IME. If result is not needed, use #hideSoftInputFromView(android.view.View,int) instead.

Request to hide the soft input window from the context of the window that is currently accepting input. This should be called as a result of the user doing some actually than fairly explicitly requests to have the input window hidden.

Caveat: ResultReceiver instance passed to this method can be a long-lived object, because it may not be garbage-collected until all the corresponding ResultReceiver objects transferred to different processes get garbage-collected. Follow the general patterns to avoid memory leaks in Android. Consider to use java.lang.ref.WeakReference so that application logic objects such as android.app.Activity and Context can be garbage collected regardless of the lifetime of ResultReceiver.

Parameters
windowToken	IBinder!: The token of the window that is making the request, as returned by View.getWindowToken().
resultReceiver	ResultReceiver!: If non-null, this will be called by the IME when it has processed your request to tell you what it has done. The result code you receive may be either RESULT_UNCHANGED_SHOWN, RESULT_UNCHANGED_HIDDEN, RESULT_SHOWN, or RESULT_HIDDEN.
flags	Int: Value is either 0 or a combination of android.view.inputmethod.InputMethodManager#HIDE_IMPLICIT_ONLY, and android.view.inputmethod.InputMethodManager#HIDE_NOT_ALWAYS

Return
Boolean	true if a request was sent to system_server, false otherwise. Note: this does not return result of the request. For result use {@param resultReceiver} instead.

hideStatusIcon

Added in API level 3
Deprecated in API level 28

fun hideStatusIcon(imeToken: IBinder!): Unit

Deprecated: Use InputMethodService.hideStatusIcon() instead. This method was intended for IME developers who should be accessing APIs through the service. APIs in this class are intended for app developers interacting with the IME.

invalidateInput

Added in API level 33

fun invalidateInput(view: View): Unit

Gives a hint to the system that the text associated with view is updated by something that is not an input method editor (IME), so that the system can cancel any pending text editing requests from the IME until it receives the new editing context such as surrounding text provided by InputConnection.takeSnapshot().

When view does not support InputConnection.takeSnapshot() protocol, calling this method may trigger View.onCreateInputConnection(EditorInfo).

Unlike restartInput(android.view.View), this API does not immediately interact with InputConnection. Instead, the application may later receive InputConnection.takeSnapshot() as needed so that the system can capture new editing context for the IME. For instance, successive invocations of this API can be coerced into a single (or zero) callback of InputConnection.takeSnapshot().

Parameters
view	View: The view whose text has changed. This value cannot be null.

See Also

• #restartInput(View)

isAcceptingText

Added in API level 3

fun isAcceptingText(): Boolean

Return true if the currently served view is accepting full text edits. If false, it has no input connection, so it can only handle raw key events.

isActive

Added in API level 3

fun isActive(): Boolean

Return true if any view is currently active for the input method.

isActive

Added in API level 3

fun isActive(view: View!): Boolean

Return true if the given view is the currently active view for the input method.

isConnectionlessStylusHandwritingAvailable

Added in API level 35

fun isConnectionlessStylusHandwritingAvailable(): Boolean

Returns true if the currently selected IME supports connectionless stylus handwriting sessions and is enabled.

isFullscreenMode

Added in API level 3

fun isFullscreenMode(): Boolean

Allows you to discover whether the attached input method is running in fullscreen mode. Return true if it is fullscreen, entirely covering your UI, else returns false.

isInputMethodSuppressingSpellChecker

Added in API level 31

fun isInputMethodSuppressingSpellChecker(): Boolean

Return true if the input method is suppressing system spell checker.

isStylusHandwritingAvailable

Added in API level 34

fun isStylusHandwritingAvailable(): Boolean

Returns true if currently selected IME supports Stylus handwriting & is enabled. If the method returns false, startStylusHandwriting(android.view.View) shouldn't be called and Stylus touch should continue as normal touch input.

See Also

• #startStylusHandwriting(View)

isWatchingCursor

Added in API level 3
Deprecated in API level 21

fun isWatchingCursor(view: View!): Boolean

Deprecated: Use InputConnection.requestCursorUpdates(int) instead.

Return true if the current input method wants to watch the location of the input editor's cursor in its window.

prepareStylusHandwritingDelegation

Added in API level 34

fun prepareStylusHandwritingDelegation(delegatorView: View): Unit

Prepares delegation of starting stylus handwriting session to a different editor in same or different window than the view on which initial handwriting stroke was detected. Delegation can be used to start stylus handwriting session before the Editor view or its InputConnection is started. Calling this method starts buffering of stylus motion events until acceptStylusHandwritingDelegation(android.view.View) is called, at which point the handwriting session can be started and the buffered stylus motion events will be delivered to the IME. e.g. Delegation can be used when initial handwriting stroke is on a pseudo Editor like widget (with no InputConnection) but actual Editor is on a different window.

Note: If an actual Editor capable of InputConnection is being scribbled upon using stylus, use startStylusHandwriting(android.view.View) instead.

Parameters
delegatorView	View: the view that receives initial stylus stroke and delegates it to the actual editor. Its window must have focus. This value cannot be null.

See Also

• #prepareStylusHandwritingDelegation(View, String)
• #acceptStylusHandwritingDelegation(View)
• #startStylusHandwriting(View)

prepareStylusHandwritingDelegation

Added in API level 34

fun prepareStylusHandwritingDelegation(
    delegatorView: View, 
    delegatePackageName: String
): Unit

Prepares delegation of starting stylus handwriting session to a different editor in same or a different window in a different package than the view on which initial handwriting stroke was detected. Delegation can be used to start stylus handwriting session before the Editor view or its InputConnection is started. Calling this method starts buffering of stylus motion events until acceptStylusHandwritingDelegation(android.view.View,java.lang.String) is called, at which point the handwriting session can be started and the buffered stylus motion events will be delivered to the IME. e.g. Delegation can be used when initial handwriting stroke is on a pseudo Editor like widget (with no InputConnection) but actual Editor is on a different window in the given package.

Note: If delegator and delegate are in same package use prepareStylusHandwritingDelegation(android.view.View) instead.

Parameters
delegatorView	View: the view that receives initial stylus stroke and delegates it to the actual editor. Its window must have focus. This value cannot be null.
delegatePackageName	String: package name that contains actual Editor which should start stylus handwriting session by calling #acceptStylusHandwritingDelegation. This value cannot be null.

See Also

• #prepareStylusHandwritingDelegation(View)
• #acceptStylusHandwritingDelegation(View, String)

restartInput

Added in API level 3

fun restartInput(view: View!): Unit

If the input method is currently connected to the given view, restart it with its new contents. You should call this when the text within your view changes outside of the normal input method or key input flow, such as when an application calls TextView.setText().

Parameters
view	View!: The view whose text has changed.

sendAppPrivateCommand

Added in API level 3

fun sendAppPrivateCommand(
    view: View!, 
    action: String!, 
    data: Bundle!
): Unit

Call InputMethodSession.appPrivateCommand() on the current Input Method.

Parameters
view	View!: Optional View that is sending the command, or null if you want to send the command regardless of the view that is attached to the input method.
action	String!: Name of the command to be performed. This must be a scoped name, i.e. prefixed with a package name you own, so that different developers will not create conflicting commands.
data	Bundle!: Any data to include with the command.

setAdditionalInputMethodSubtypes

Added in API level 14
Deprecated in API level 29

fun setAdditionalInputMethodSubtypes(
    imiId: String, 
    subtypes: Array<InputMethodSubtype!>
): Unit

Deprecated: For IMEs that have already implemented features like customizable/downloadable keyboard layouts/languages, please start migration to other approaches. One idea would be exposing only one unified InputMethodSubtype then implement IME's own language switching mechanism within that unified subtype. The support of "Additional Subtype" may be completely dropped in a future version of Android.

Set additional input method subtypes. Only a process which shares the same uid with the IME can add additional input method subtypes to the IME. Please note that a subtype's status is stored in the system. For example, enabled subtypes are remembered by the framework even after they are removed by using this method. If you re-add the same subtypes again, they will just get enabled. If you want to avoid such conflicts, for instance, you may want to create a "different" new subtype even with the same locale and mode, by changing its extra value. The different subtype won't get affected by the stored past status. (You may want to take a look at InputMethodSubtype.hashCode() to refer to the current implementation.)

NOTE: If the same subtype exists in both the manifest XML file and additional subtypes specified by subtypes, those multiple instances are automatically merged into one instance.

CAVEAT: In API Level 23 and prior, the system may do nothing if an empty InputMethodSubtype is specified in subtypes, which prevents you from removing the last one entry of additional subtypes. If your IME statically defines one or more subtypes in the manifest XML file, you may be able to work around this limitation by specifying one of those statically defined subtypes in subtypes.

Parameters
imiId	String: Id of InputMethodInfo which additional input method subtypes will be added to. If the imiId is null, system would do nothing for this operation.
subtypes	Array<InputMethodSubtype!>: subtypes will be added as additional subtypes of the current input method. If the subtypes is null, system would do nothing for this operation.

setCurrentInputMethodSubtype

Added in API level 11
Deprecated in API level 29

fun setCurrentInputMethodSubtype(subtype: InputMethodSubtype!): Boolean

Deprecated: If the calling process is an IME, use InputMethodService.switchInputMethod(String, InputMethodSubtype), which does not require any permission as long as the caller is the current IME. If the calling process is some privileged app that already has Manifest.permission.WRITE_SECURE_SETTINGS permission, just directly update Settings.Secure.SELECTED_INPUT_METHOD_SUBTYPE.

Switch to a new input method subtype of the current input method.
Requires android.Manifest.permission#WRITE_SECURE_SETTINGS

Parameters
subtype	InputMethodSubtype!: A new input method subtype to switch.

Return
Boolean	true if the current subtype was successfully switched. When the specified subtype is null, this method returns false.

setExplicitlyEnabledInputMethodSubtypes

Added in API level 34

fun setExplicitlyEnabledInputMethodSubtypes(
    imiId: String, 
    subtypeHashCodes: IntArray
): Unit

Updates the list of explicitly enabled InputMethodSubtype for a given IME owned by the calling process.

By default each IME has no explicitly enabled InputMethodSubtype. In this state the system will decide what InputMethodSubtype should be enabled by using information available at runtime as per-user language settings. Users can, however, manually pick up one or more InputMethodSubtype to be enabled on an Activity shown by showInputMethodAndSubtypeEnabler(java.lang.String). Such a manual change is stored in Settings.Secure.ENABLED_INPUT_METHODS so that the change can persist across reboots. Settings.Secure.ENABLED_INPUT_METHODS stores InputMethodSubtype.hashCode() as the identifier of InputMethodSubtype for historical reasons.

This API provides a safe and managed way for IME developers to modify what InputMethodSubtype are referenced in Settings.Secure.ENABLED_INPUT_METHODS for their own IME. One use case is when IME developers want to use their own Activity for users to pick up InputMethodSubtype. Another use case is for IME developers to fix up any stale and/or invalid value stored in Settings.Secure.ENABLED_INPUT_METHODS without bothering users. Passing an empty subtypeHashCodes is guaranteed to reset the state to default.

To control the return value of InputMethodSubtype.hashCode()

android.R.attr#subtypeId and android.view.inputmethod.InputMethodSubtype.InputMethodSubtypeBuilder#setSubtypeId(int) are available for IME developers to control the return value of InputMethodSubtype.hashCode(). Beware that -1 is not a valid value of InputMethodSubtype.hashCode() for historical reasons.

Note for Direct Boot support

While IME developers can call this API even before android.os.UserManager#isUserUnlocked() becomes true, such a change is volatile thus remains effective only until android.os.UserManager#isUserUnlocked() becomes true or the device is rebooted. To make the change persistent IME developers need to call this API again after receiving Intent.ACTION_USER_UNLOCKED.

Parameters
imiId	String: IME ID. The specified IME and the calling process need to belong to the same package. Otherwise SecurityException will be thrown. This value cannot be null.
subtypeHashCodes	IntArray: An arrays of InputMethodSubtype.hashCode() to be explicitly enabled. Entries that are found in the specified IME will be silently ignored. Pass an empty array to reset the state to default. This value cannot be null.

Exceptions
java.lang.NullPointerException	if subtypeHashCodes is null.
java.lang.SecurityException	if the specified IME and the calling process do not belong to the same package.

setInputMethod

Added in API level 3
Deprecated in API level 28

fun setInputMethod(
    token: IBinder!, 
    id: String!
): Unit

Deprecated: Use InputMethodService.switchInputMethod(String) instead. This method was intended for IME developers who should be accessing APIs through the service. APIs in this class are intended for app developers interacting with the IME.

Force switch to a new input method component. This can only be called from an application or a service which has a token of the currently active input method.

On Android Build.VERSION_CODES.Q and later devices, the undocumented behavior that token can be null when the caller has Manifest.permission.WRITE_SECURE_SETTINGS is deprecated. Instead, update android.provider.Settings.Secure#DEFAULT_INPUT_METHOD and android.provider.Settings.Secure#SELECTED_INPUT_METHOD_SUBTYPE directly.

Parameters
token	IBinder!: Supplies the identifying token given to an input method when it was started, which allows it to perform this operation on itself.
id	String!: The unique identifier for the new input method to be switched to.

Exceptions
java.lang.IllegalArgumentException	if the input method is unknown or filtered by the rules of package visibility.

setInputMethodAndSubtype

Added in API level 11
Deprecated in API level 28

fun setInputMethodAndSubtype(
    token: IBinder, 
    id: String!, 
    subtype: InputMethodSubtype!
): Unit

Deprecated: Use InputMethodService.switchInputMethod(String, InputMethodSubtype) instead. This method was intended for IME developers who should be accessing APIs through the service. APIs in this class are intended for app developers interacting with the IME.

Force switch to a new input method and subtype. This can only be called from an application or a service which has a token of the currently active input method.

On Android Build.VERSION_CODES.Q and later devices, token cannot be null even with Manifest.permission.WRITE_SECURE_SETTINGS. Instead, update android.provider.Settings.Secure#DEFAULT_INPUT_METHOD and android.provider.Settings.Secure#SELECTED_INPUT_METHOD_SUBTYPE directly.

Parameters
token	IBinder: Supplies the identifying token given to an input method when it was started, which allows it to perform this operation on itself. This value cannot be null.
id	String!: The unique identifier for the new input method to be switched to.
subtype	InputMethodSubtype!: The new subtype of the new input method to be switched to.

Exceptions
java.lang.IllegalArgumentException	if the input method is unknown or filtered by the rules of package visibility.

shouldOfferSwitchingToNextInputMethod

Added in API level 19
Deprecated in API level 28

fun shouldOfferSwitchingToNextInputMethod(imeToken: IBinder!): Boolean

Deprecated: Use InputMethodService.shouldOfferSwitchingToNextInputMethod() instead. This method was intended for IME developers who should be accessing APIs through the service. APIs in this class are intended for app developers interacting with the IME.

Returns true if the current IME needs to offer the users ways to switch to a next input method (e.g. a globe key.). When an IME sets supportsSwitchingToNextInputMethod and this method returns true, the IME has to offer ways to to invoke switchToNextInputMethod accordingly.

Note that the system determines the most appropriate next input method and subtype in order to provide the consistent user experience in switching between IMEs and subtypes.

Parameters
imeToken	IBinder!: Supplies the identifying token given to an input method when it was started, which allows it to perform this operation on itself.

showInputMethodAndSubtypeEnabler

Added in API level 11

fun showInputMethodAndSubtypeEnabler(imiId: String?): Unit

Show the settings for enabling subtypes of the specified input method.

Parameters
imiId	String?: An input method, whose subtypes settings will be shown. If imiId is null, subtypes of all input methods will be shown.

showInputMethodPicker

Added in API level 3

fun showInputMethodPicker(): Unit

Show IME picker popup window.

Requires the PackageManager.FEATURE_INPUT_METHODS feature which can be detected using PackageManager.hasSystemFeature(String).

showSoftInput

Added in API level 3

fun showSoftInput(
    view: View!, 
    flags: Int
): Boolean

Synonym for showSoftInput(android.view.View,int,android.os.ResultReceiver) without a result receiver: explicitly request that the current input method's soft input area be shown to the user, if needed.

Parameters
view	View!: The currently focused view, which would like to receive soft keyboard input. Note that this view is only considered focused here if both it itself has view focus, and its containing window has window focus. Otherwise the call fails and returns false.
flags	Int: Value is either 0 or a combination of android.view.inputmethod.InputMethodManager#SHOW_IMPLICIT, and android.view.inputmethod.InputMethodManager#SHOW_FORCED

Return
Boolean	true if a request was sent to system_server, false otherwise. Note: this does not return result of the request. For result use {@param resultReceiver} instead.

showSoftInput

Added in API level 3
Deprecated in API level Baklava

fun showSoftInput(
    view: View!, 
    flags: Int, 
    resultReceiver: ResultReceiver!
): Boolean

Deprecated: The ResultReceiver is not a reliable way of determining whether the Input Method is actually shown or hidden. If result is needed, use android.view.WindowInsetsController#show instead and set a View.OnApplyWindowInsetsListener and verify the provided WindowInsets for the visibility of IME. If result is not needed, use showSoftInput(android.view.View,int) instead.

Explicitly request that the current input method's soft input area be shown to the user, if needed. Call this if the user interacts with your view in such a way that they have expressed they would like to start performing input into it.

Caveat: ResultReceiver instance passed to this method can be a long-lived object, because it may not be garbage-collected until all the corresponding ResultReceiver objects transferred to different processes get garbage-collected. Follow the general patterns to avoid memory leaks in Android. Consider to use java.lang.ref.WeakReference so that application logic objects such as android.app.Activity and Context can be garbage collected regardless of the lifetime of ResultReceiver.

Parameters
view	View!: The currently focused view, which would like to receive soft keyboard input. Note that this view is only considered focused here if both it itself has view focus, and its containing window has window focus. Otherwise the call fails and returns false.
resultReceiver	ResultReceiver!: If non-null, this will be called by the IME when it has processed your request to tell you what it has done. The result code you receive may be either RESULT_UNCHANGED_SHOWN, RESULT_UNCHANGED_HIDDEN, RESULT_SHOWN, or RESULT_HIDDEN.
flags	Int: Value is either 0 or a combination of android.view.inputmethod.InputMethodManager#SHOW_IMPLICIT, and android.view.inputmethod.InputMethodManager#SHOW_FORCED

Return
Boolean	true if a request was sent to system_server, false otherwise. Note: this does not return result of the request. For result use {@param resultReceiver} instead.

showSoftInputFromInputMethod

Added in API level 3
Deprecated in API level 28

fun showSoftInputFromInputMethod(
    token: IBinder!, 
    flags: Int
): Unit

Deprecated: Use InputMethodService.requestShowSelf(int) instead. This method was intended for IME developers who should be accessing APIs through the service. APIs in this class are intended for app developers interacting with the IME.

Show the input method's soft input area, so the user sees the input method window and can interact with it. This can only be called from the currently active input method, as validated by the given token.

Parameters
token	IBinder!: Supplies the identifying token given to an input method when it was started, which allows it to perform this operation on itself.
flags	Int: Value is either 0 or a combination of android.view.inputmethod.InputMethodManager#SHOW_IMPLICIT, and android.view.inputmethod.InputMethodManager#SHOW_FORCED

showStatusIcon

Added in API level 3
Deprecated in API level 28

fun showStatusIcon(
    imeToken: IBinder!, 
    packageName: String!, 
    iconId: Int
): Unit

Deprecated: Use InputMethodService.showStatusIcon(int) instead. This method was intended for IME developers who should be accessing APIs through the service. APIs in this class are intended for app developers interacting with the IME.

startConnectionlessStylusHandwriting

Added in API level 35

fun startConnectionlessStylusHandwriting(
    view: View, 
    cursorAnchorInfo: CursorAnchorInfo?, 
    callbackExecutor: Executor, 
    callback: ConnectionlessHandwritingCallback
): Unit

Starts a connectionless stylus handwriting session. A connectionless session differs from a regular stylus handwriting session in that the IME does not use an input connection to communicate with a text editor. Instead, the IME directly returns recognised handwritten text via a callback.

The {code cursorAnchorInfo} may be used by the IME to improve the handwriting recognition accuracy and user experience of the handwriting session. Usually connectionless handwriting is used for a view which appears like a text editor but does not really support text editing. For best results, the {code cursorAnchorInfo} should be populated as it would be for a real text editor (for example, the insertion marker location can be set to where the user would expect it to be, even if there is no visible cursor).

Parameters
view	View: the view receiving stylus events This value cannot be null.
cursorAnchorInfo	CursorAnchorInfo?: positional information about the view receiving stylus events This value may be null.
callbackExecutor	Executor: the executor to run the callback on This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread.
callback	ConnectionlessHandwritingCallback: the callback to receive the result This value cannot be null.

startConnectionlessStylusHandwritingForDelegation

Added in API level 35

fun startConnectionlessStylusHandwritingForDelegation(
    delegatorView: View, 
    cursorAnchorInfo: CursorAnchorInfo?, 
    delegatePackageName: String, 
    callbackExecutor: Executor, 
    callback: ConnectionlessHandwritingCallback
): Unit

Starts a connectionless stylus handwriting session (see startConnectionlessStylusHandwriting) and additionally enables the recognised handwritten text to be later committed to a text editor using acceptStylusHandwritingDelegation(android.view.View,java.lang.String).

After a connectionless session started using this method completes successfully, a text editor view, called the delegate view, may call acceptStylusHandwritingDelegation(android.view.View,java.lang.String) which will request the IME to commit the recognised handwritten text from the connectionless session to the delegate view.

The delegate view must belong to delegatePackageName for the delegation to succeed.

Parameters
delegatorView	View: the view receiving stylus events This value cannot be null.
cursorAnchorInfo	CursorAnchorInfo?: positional information about the view receiving stylus events This value may be null.
delegatePackageName	String: name of the package containing the delegate view which will accept the delegation This value cannot be null.
callbackExecutor	Executor: the executor to run the callback on This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread.
callback	ConnectionlessHandwritingCallback: the callback to receive the result This value cannot be null.

startConnectionlessStylusHandwritingForDelegation

Added in API level 35

fun startConnectionlessStylusHandwritingForDelegation(
    delegatorView: View, 
    cursorAnchorInfo: CursorAnchorInfo?, 
    callbackExecutor: Executor, 
    callback: ConnectionlessHandwritingCallback
): Unit

Starts a connectionless stylus handwriting session (see startConnectionlessStylusHandwriting) and additionally enables the recognised handwritten text to be later committed to a text editor using acceptStylusHandwritingDelegation(android.view.View).

After a connectionless session started using this method completes successfully, a text editor view, called the delegate view, may call acceptStylusHandwritingDelegation(android.view.View) which will request the IME to commit the recognised handwritten text from the connectionless session to the delegate view.

The delegate view must belong to the same package as the delegator view for the delegation to succeed. If the delegate view belongs to a different package, use startConnectionlessStylusHandwritingForDelegation(android.view.View,android.view.inputmethod.CursorAnchorInfo,java.lang.String,java.util.concurrent.Executor,android.view.inputmethod.ConnectionlessHandwritingCallback) instead.

Parameters
delegatorView	View: the view receiving stylus events This value cannot be null.
cursorAnchorInfo	CursorAnchorInfo?: positional information about the view receiving stylus events This value may be null.
callbackExecutor	Executor: the executor to run the callback on This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread.
callback	ConnectionlessHandwritingCallback: the callback to receive the result This value cannot be null.

startStylusHandwriting

Added in API level 33

fun startStylusHandwriting(view: View): Unit

Start stylus handwriting session. If supported by the current input method, a stylus handwriting session is started on the given View, capturing all stylus input and converting it to InputConnection commands. If handwriting mode is started successfully by the IME, any currently dispatched stylus pointers will be android.view.MotionEvent#FLAG_CANCELED cancelled. If Stylus handwriting mode is not supported or cannot be fulfilled for any reason by IME, request will be ignored and Stylus touch will continue as normal touch input. Ideally, isStylusHandwritingAvailable() should be called first to determine if stylus handwriting is supported by IME.

Parameters
view	View: the View for which stylus handwriting is requested. It and its window must be focused. This value cannot be null.

See Also

• #isStylusHandwritingAvailable()

switchToLastInputMethod

Added in API level 11
Deprecated in API level 28

fun switchToLastInputMethod(imeToken: IBinder!): Boolean

Deprecated: Use InputMethodService.switchToPreviousInputMethod() instead. This method was intended for IME developers who should be accessing APIs through the service. APIs in this class are intended for app developers interacting with the IME.

Force switch to the last used input method and subtype. If the last input method didn't have any subtypes, the framework will simply switch to the last input method with no subtype specified.

Parameters
imeToken	IBinder!: Supplies the identifying token given to an input method when it was started, which allows it to perform this operation on itself.

Return
Boolean	true if the current input method and subtype was successfully switched to the last used input method and subtype.

switchToNextInputMethod

Added in API level 16
Deprecated in API level 28

fun switchToNextInputMethod(
    imeToken: IBinder!, 
    onlyCurrentIme: Boolean
): Boolean

Deprecated: Use InputMethodService.switchToNextInputMethod(boolean) instead. This method was intended for IME developers who should be accessing APIs through the service. APIs in this class are intended for app developers interacting with the IME.

Force switch to the next input method and subtype. If there is no IME enabled except current IME and subtype, do nothing.

Parameters
imeToken	IBinder!: Supplies the identifying token given to an input method when it was started, which allows it to perform this operation on itself.
onlyCurrentIme	Boolean: if true, the framework will find the next subtype which belongs to the current IME

Return
Boolean	true if the current input method and subtype was successfully switched to the next input method and subtype.

toggleSoftInput

Added in API level 3
Deprecated in API level 31

fun toggleSoftInput(
    showFlags: Int, 
    hideFlags: Int
): Unit

Deprecated: Use showSoftInput(android.view.View,int) or hideSoftInputFromWindow(android.os.IBinder,int) explicitly instead. In particular during focus changes, the current visibility of the IME is not well defined. Starting in Android S, this only has an effect if the calling app is the current IME focus.

This method toggles the input method window display. If the input window is already displayed, it gets hidden. If not the input window will be displayed.

Parameters
showFlags	Int: Value is either 0 or a combination of android.view.inputmethod.InputMethodManager#SHOW_IMPLICIT, and android.view.inputmethod.InputMethodManager#SHOW_FORCED
hideFlags	Int: Value is either 0 or a combination of android.view.inputmethod.InputMethodManager#HIDE_IMPLICIT_ONLY, and android.view.inputmethod.InputMethodManager#HIDE_NOT_ALWAYS

toggleSoftInputFromWindow

Added in API level 3
Deprecated in API level 31

fun toggleSoftInputFromWindow(
    windowToken: IBinder!, 
    showFlags: Int, 
    hideFlags: Int
): Unit

Deprecated: Use showSoftInput(android.view.View,int) or hideSoftInputFromWindow(android.os.IBinder,int) explicitly instead. In particular during focus changes, the current visibility of the IME is not well defined. Starting in Android S, this only has an effect if the calling app is the current IME focus.

This method toggles the input method window display. If the input window is already displayed, it gets hidden. If not the input window will be displayed.

Parameters
windowToken	IBinder!: The token of the window that is making the request, as returned by View.getWindowToken().
showFlags	Int: Value is either 0 or a combination of android.view.inputmethod.InputMethodManager#SHOW_IMPLICIT, and android.view.inputmethod.InputMethodManager#SHOW_FORCED
hideFlags	Int: Value is either 0 or a combination of android.view.inputmethod.InputMethodManager#HIDE_IMPLICIT_ONLY, and android.view.inputmethod.InputMethodManager#HIDE_NOT_ALWAYS

updateCursor

Added in API level 3
Deprecated in API level 21

fun updateCursor(
    view: View!, 
    left: Int, 
    top: Int, 
    right: Int, 
    bottom: Int
): Unit

Deprecated: Use updateCursorAnchorInfo(android.view.View,android.view.inputmethod.CursorAnchorInfo) instead.

Report the current cursor location in its window.

updateCursorAnchorInfo

Added in API level 21

fun updateCursorAnchorInfo(
    view: View!, 
    cursorAnchorInfo: CursorAnchorInfo!
): Unit

Report positional change of the text insertion point and/or characters in the composition string.

updateExtractedText

Added in API level 3

fun updateExtractedText(
    view: View!, 
    token: Int, 
    text: ExtractedText!
): Unit

updateSelection

Added in API level 3

fun updateSelection(
    view: View!, 
    selStart: Int, 
    selEnd: Int, 
    candidatesStart: Int, 
    candidatesEnd: Int
): Unit

Report the current selection range.

Editor authors, you need to call this method whenever the cursor moves in your editor. Remember that in addition to doing this, your editor needs to always supply current cursor values in EditorInfo.initialSelStart and EditorInfo.initialSelEnd every time android.view.View#onCreateInputConnection(EditorInfo) is called, which happens whenever the keyboard shows up or the focus changes to a text field, among other cases.

viewClicked

Added in API level 14
Deprecated in API level 29

fun viewClicked(view: View!): Unit

Deprecated: The semantics of this method can never be defined well for composite View that works as a giant "Canvas", which can host its own UI hierarchy and sub focus state. android.webkit.WebView is a good example. Application / IME developers should not rely on this method.

Notify the event when the user tapped or clicked the text view.

Parameters
view	View!: View which is being clicked.

See Also

• android.inputmethodservice.InputMethodService#onViewClicked(boolean)