InputMethodSession

appPrivateCommand

abstract fun appPrivateCommand(
    action: String!, 
    data: Bundle!
): Unit

Process a private command sent from the application to the input method. This can be used to provide domain-specific features that are only known between certain input methods and their clients.

dispatchGenericMotionEvent

abstract fun dispatchGenericMotionEvent(
    seq: Int, 
    event: MotionEvent!, 
    callback: InputMethodSession.EventCallback!
): Unit

This method is called when there is a generic motion event.

If the input method wants to handle this event, return true, otherwise return false and the caller (i.e. the application) will handle the event.

dispatchKeyEvent

abstract fun dispatchKeyEvent(
    seq: Int, 
    event: KeyEvent!, 
    callback: InputMethodSession.EventCallback!
): Unit

This method is called when a key is pressed. When done with the event, the implementation must call back on callback with its result.

If the input method wants to handle this event, return true, otherwise return false and the caller (i.e. the application) will handle the event.

dispatchTrackballEvent

abstract fun dispatchTrackballEvent(
    seq: Int, 
    event: MotionEvent!, 
    callback: InputMethodSession.EventCallback!
): Unit

This method is called when there is a track ball event.

If the input method wants to handle this event, return true, otherwise return false and the caller (i.e. the application) will handle the event.

displayCompletions

abstract fun displayCompletions(completions: Array<CompletionInfo!>!): Unit

Called by a text editor that performs auto completion, to tell the input method about the completions it has available. This can be used by the input method to display them to the user to select the text to be inserted.

finishInput

abstract fun finishInput(): Unit

This method is called when the application would like to stop receiving text input.

toggleSoftInput

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

Deprecated: Starting in android.os.Build.VERSION_CODES#S the system no longer invokes this method, instead it explicitly shows or hides the IME. An InputMethodService wishing to toggle its own visibility should instead invoke android.inputmethodservice.InputMethodService#requestShowSelf or InputMethodService.requestHideSelf

Toggle the soft input window. Applications can toggle the state of the soft input window.

updateCursor

abstract fun updateCursor(newCursor: Rect!): Unit

This method is called when cursor location of the target input field has changed within its window. This is not normally called, but will only be reported if requested by the input method.

updateCursorAnchorInfo

abstract fun updateCursorAnchorInfo(cursorAnchorInfo: CursorAnchorInfo!): Unit

This method is called when the cursor and/or the character position relevant to text input is changed on the screen. This is not called by default. It will only be reported if requested by the input method.

updateExtractedText

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

Called by a text editor to report its new extracted text when its contents change. This will only be called if the input method calls InputConnection.getExtractedText() with the option to report updates.

updateSelection

abstract fun updateSelection(
    oldSelStart: Int, 
    oldSelEnd: Int, 
    newSelStart: Int, 
    newSelEnd: Int, 
    candidatesStart: Int, 
    candidatesEnd: Int
): Unit

This method is called when the selection or cursor in the current target input field has changed.

viewClicked

abstract fun viewClicked(focusChanged: Boolean): Unit

This method is called when the user tapped a text view. IMEs can't rely on this method being called because this was not part of the original IME protocol, so applications with custom text editing written before this method appeared will not call to inform the IME of this interaction.