droid-mcp-ime/io.droidmcp.ime/DroidMcpInputMethodService

DroidMcpInputMethodService

abstract class DroidMcpInputMethodService : InputMethodService

Abstract InputMethodService that hosts droid-mcp's "LLM keyboard." Renders a minimal input view (typing is driven by MCP tools, not by user touches on a key grid) with a single "Switch back" button so users can return to their normal keyboard, and registers itself with InputMethodServiceHolder so tools can reach the currently-bound InputConnection.

The host app:

Declares a concrete subclass in its manifest with android.permission.BIND_INPUT_METHOD and an <intent-filter> for android.view.InputMethod.
Points <meta-data android:name="android.view.im" android:resource="@xml/droid_mcp_ime_config" /> at the shipped default config (or supplies its own).
User adds the keyboard via Settings > System > Languages & input > On-screen keyboard > Manage on-screen keyboards, then picks it via the IME picker.

Constructors

DroidMcpInputMethodService

constructor()

Properties

application

val application: Application?

applicationContext

open val applicationContext: Context?

applicationInfo

open val applicationInfo: ApplicationInfo?

assets

open val assets: AssetManager?

attributionSource

open val attributionSource: AttributionSource

attributionTag

open val attributionTag: String?

backDisposition

open var backDisposition: Int

baseContext

open val baseContext: Context?

cacheDir

open val cacheDir: File?

candidatesHiddenVisibility

open val candidatesHiddenVisibility: Int

classLoader

open val classLoader: ClassLoader?

codeCacheDir

open val codeCacheDir: File?

contentResolver

open val contentResolver: ContentResolver?

currentInputBinding

open val currentInputBinding: InputBinding?

currentInputConnection

open val currentInputConnection: InputConnection?

currentInputEditorInfo

open val currentInputEditorInfo: EditorInfo?

currentInputStarted

open val currentInputStarted: Boolean

dataDir

open val dataDir: File?

deviceId

open val deviceId: Int

display

open val display: Display?

externalCacheDir

open val externalCacheDir: File?

externalCacheDirs

open val externalCacheDirs: Array<out File?>?

externalMediaDirs

open val externalMediaDirs: Array<out File?>?

filesDir

open val filesDir: File?

foregroundServiceType

val foregroundServiceType: Int

inputMethodWindowRecommendedHeight

open val inputMethodWindowRecommendedHeight: Int

isDeviceProtectedStorage

open val isDeviceProtectedStorage: Boolean

isExtractViewShown

open var isExtractViewShown: Boolean

isFullscreenMode

open val isFullscreenMode: Boolean

isInputViewShown

open val isInputViewShown: Boolean

isRestricted

open val isRestricted: Boolean

isShowInputRequested

open val isShowInputRequested: Boolean

isUiContext

open val isUiContext: Boolean

keyDispatcherState

open val keyDispatcherState: KeyEvent.DispatcherState?

layoutInflater

open val layoutInflater: LayoutInflater?

mainExecutor

open val mainExecutor: Executor?

mainLooper

open val mainLooper: Looper?

maxWidth

open val maxWidth: Int

noBackupFilesDir

open val noBackupFilesDir: File?

obbDir

open val obbDir: File?

obbDirs

open val obbDirs: Array<out File?>?

opPackageName

open val opPackageName: String

packageCodePath

open val packageCodePath: String?

packageManager

open val packageManager: PackageManager?

packageName

open val packageName: String?

packageResourcePath

open val packageResourcePath: String?

params

open val params: ContextParams?

resources

open val resources: Resources?

stylusHandwritingSessionTimeout

var stylusHandwritingSessionTimeout: Duration

stylusHandwritingWindow

val stylusHandwritingWindow: Window?

theme

open val theme: Resources.Theme?

wallpaper

open val wallpaper: Drawable?

wallpaperDesiredMinimumHeight

open val wallpaperDesiredMinimumHeight: Int

wallpaperDesiredMinimumWidth

open val wallpaperDesiredMinimumWidth: Int

window

open val window: Dialog?

Functions

bindIsolatedService

open fun bindIsolatedService(service: Intent, flags: Context.BindServiceFlags, instanceName: String, executor: Executor, conn: ServiceConnection): Boolean

open fun bindIsolatedService(service: Intent, flags: Int, instanceName: String, executor: Executor, conn: ServiceConnection): Boolean

bindService

open fun bindService(service: Intent, conn: ServiceConnection, flags: Context.BindServiceFlags): Boolean

open fun bindService(service: Intent, conn: ServiceConnection, flags: Int): Boolean

open fun bindService(service: Intent, flags: Context.BindServiceFlags, executor: Executor, conn: ServiceConnection): Boolean

open fun bindService(service: Intent, flags: Int, executor: Executor, conn: ServiceConnection): Boolean

bindServiceAsUser

open fun bindServiceAsUser(service: Intent, conn: ServiceConnection, flags: Context.BindServiceFlags, user: UserHandle): Boolean

open fun bindServiceAsUser(service: Intent, conn: ServiceConnection, flags: Int, user: UserHandle): Boolean

checkCallingOrSelfPermission

open fun checkCallingOrSelfPermission(permission: String): Int

checkCallingOrSelfUriPermission

open fun checkCallingOrSelfUriPermission(uri: Uri?, modeFlags: Int): Int

checkCallingOrSelfUriPermissions

open fun checkCallingOrSelfUriPermissions(uris: List<Uri?>, modeFlags: Int): IntArray

checkCallingPermission

open fun checkCallingPermission(permission: String): Int

checkCallingUriPermission

open fun checkCallingUriPermission(uri: Uri?, modeFlags: Int): Int

checkCallingUriPermissions

open fun checkCallingUriPermissions(uris: List<Uri?>, modeFlags: Int): IntArray

checkContentUriPermissionFull

open fun checkContentUriPermissionFull(uri: Uri, pid: Int, uid: Int, modeFlags: Int): Int

checkPermission

open fun checkPermission(permission: String, pid: Int, uid: Int): Int

checkSelfPermission

open fun checkSelfPermission(permission: String): Int

checkUriPermission

open fun checkUriPermission(uri: Uri?, pid: Int, uid: Int, modeFlags: Int): Int

open fun checkUriPermission(uri: Uri?, readPermission: String?, writePermission: String?, pid: Int, uid: Int, modeFlags: Int): Int

checkUriPermissions

open fun checkUriPermissions(uris: List<Uri?>, pid: Int, uid: Int, modeFlags: Int): IntArray

clearWallpaper

open fun ~~clearWallpaper~~()

connection

fun connection(): InputConnection?

Live InputConnection for the currently-focused field, or null if the IME isn't currently driving an editor.

createAttributionContext

open fun createAttributionContext(attributionTag: String?): Context

createConfigurationContext

open fun createConfigurationContext(overrideConfiguration: Configuration): Context?

createContext

open fun createContext(contextParams: ContextParams): Context

createContextForSplit

open fun createContextForSplit(splitName: String?): Context?

createDeviceContext

open fun createDeviceContext(deviceId: Int): Context

createDeviceProtectedStorageContext

open fun createDeviceProtectedStorageContext(): Context?

createDisplayContext

open fun createDisplayContext(display: Display): Context?

createPackageContext

open fun createPackageContext(packageName: String?, flags: Int): Context?

createWindowContext

open fun createWindowContext(type: Int, options: Bundle?): Context

open fun createWindowContext(display: Display, type: Int, options: Bundle?): Context

databaseList

open fun databaseList(): Array<out String?>?

deleteDatabase

open fun deleteDatabase(name: String?): Boolean

deleteFile

open fun deleteFile(name: String?): Boolean

deleteSharedPreferences

open fun deleteSharedPreferences(name: String?): Boolean

editorInfo

fun editorInfo(): EditorInfo?

The EditorInfo captured in onStartInput for the currently-bound editor, or null when no editor is bound. Read tools use its inputType to refuse password fields (see isPasswordInputType).

enableHardwareAcceleration

open fun ~~enableHardwareAcceleration~~(): Boolean

enforceCallingOrSelfPermission

open fun enforceCallingOrSelfPermission(permission: String, message: String?)

enforceCallingOrSelfUriPermission

open fun enforceCallingOrSelfUriPermission(uri: Uri?, modeFlags: Int, message: String?)

enforceCallingPermission

open fun enforceCallingPermission(permission: String, message: String?)

enforceCallingUriPermission

open fun enforceCallingUriPermission(uri: Uri?, modeFlags: Int, message: String?)

enforcePermission

open fun enforcePermission(permission: String, pid: Int, uid: Int, message: String?)

enforceUriPermission

open fun enforceUriPermission(uri: Uri?, pid: Int, uid: Int, modeFlags: Int, message: String?)

open fun enforceUriPermission(uri: Uri?, readPermission: String?, writePermission: String?, pid: Int, uid: Int, modeFlags: Int, message: String?)

fileList

open fun fileList(): Array<out String?>?

finishConnectionlessStylusHandwriting

fun finishConnectionlessStylusHandwriting(text: CharSequence?)

finishStylusHandwriting

fun finishStylusHandwriting()

getColor

fun getColor(id: Int): Int

getColorStateList

fun getColorStateList(id: Int): ColorStateList

getDatabasePath

open fun getDatabasePath(name: String?): File?

getDir

open fun getDir(name: String?, mode: Int): File?

getDrawable

fun getDrawable(id: Int): Drawable?

getExternalFilesDir

open fun getExternalFilesDir(type: String?): File?

getExternalFilesDirs

open fun getExternalFilesDirs(type: String?): Array<out File?>?

getFileStreamPath

open fun getFileStreamPath(name: String?): File?

getSharedPreferences

open fun getSharedPreferences(name: String?, mode: Int): SharedPreferences?

getString

fun getString(resId: Int): String

fun getString(resId: Int, vararg formatArgs: Any?): String

getSystemService

fun <T : Any?> getSystemService(serviceClass: Class<T?>): T?

open fun getSystemService(name: String): Any?

getSystemServiceName

open fun getSystemServiceName(serviceClass: Class<*>): String?

getText

fun getText(resId: Int): CharSequence

getTextForImeAction

open fun getTextForImeAction(imeOptions: Int): CharSequence?

grantUriPermission

open fun grantUriPermission(toPackage: String?, uri: Uri?, modeFlags: Int)

hasFocusedEditor

fun hasFocusedEditor(): Boolean

False when the IME is only bound to the window's placeholder editor — no field has focus. Android then reports inputType = TYPE_NULL with fieldId = 0; a real editor has its view's id (or View.NO_ID, -1), so a TYPE_NULL terminal-style view still counts. Text committed to the placeholder goes nowhere, so tools must not report it as typed.

hasInputConnection

fun hasInputConnection(): Boolean

Whether an editor field is currently bound to this IME. Tools use this via InputMethodServiceHolder.isActive to short-circuit with a clear error before trying to drive an empty InputConnection.

hideStatusIcon

open fun hideStatusIcon()

hideWindow

open fun hideWindow()

moveDatabaseFrom

open fun moveDatabaseFrom(sourceContext: Context?, name: String?): Boolean

moveSharedPreferencesFrom

open fun moveSharedPreferencesFrom(sourceContext: Context?, name: String?): Boolean

obtainStyledAttributes

fun obtainStyledAttributes(attrs: IntArray): TypedArray

fun obtainStyledAttributes(set: AttributeSet?, attrs: IntArray): TypedArray

fun obtainStyledAttributes(resid: Int, attrs: IntArray): TypedArray

fun obtainStyledAttributes(set: AttributeSet?, attrs: IntArray, defStyleAttr: Int, defStyleRes: Int): TypedArray

onAppPrivateCommand

open fun onAppPrivateCommand(action: String?, data: Bundle?)

onBind

fun onBind(intent: Intent?): IBinder?

onBindInput

open fun onBindInput()

onComputeInsets

open fun onComputeInsets(outInsets: InputMethodService.Insets?)

onConfigurationChanged

open fun onConfigurationChanged(newConfig: Configuration)

onConfigureWindow

open fun onConfigureWindow(win: Window?, isFullscreen: Boolean, isCandidatesOnly: Boolean)

onCreate

open override fun onCreate()

onCreateCandidatesView

open fun onCreateCandidatesView(): View?

onCreateExtractTextView

open fun onCreateExtractTextView(): View?

onCreateInlineSuggestionsRequest

open fun onCreateInlineSuggestionsRequest(uiExtras: Bundle): InlineSuggestionsRequest?

onCreateInputMethodInterface

open fun ~~onCreateInputMethodInterface~~(): AbstractInputMethodService.AbstractInputMethodImpl?

onCreateInputMethodSessionInterface

open fun ~~onCreateInputMethodSessionInterface~~(): AbstractInputMethodService.AbstractInputMethodSessionImpl?

onCreateInputView

open override fun onCreateInputView(): View

onCustomImeSwitcherButtonRequestedVisible

open fun onCustomImeSwitcherButtonRequestedVisible(visible: Boolean)

onDestroy

open override fun onDestroy()

onDisplayCompletions

open fun onDisplayCompletions(completions: Array<out CompletionInfo?>?)

onEvaluateFullscreenMode

open fun onEvaluateFullscreenMode(): Boolean

onEvaluateInputViewShown

open fun onEvaluateInputViewShown(): Boolean

onExtractedCursorMovement

open fun onExtractedCursorMovement(dx: Int, dy: Int)

onExtractedSelectionChanged

open fun onExtractedSelectionChanged(start: Int, end: Int)

onExtractedTextClicked

open fun onExtractedTextClicked()

onExtractingInputChanged

open fun onExtractingInputChanged(ei: EditorInfo?)

onExtractTextContextMenuItem

open fun onExtractTextContextMenuItem(id: Int): Boolean

onFinishCandidatesView

open fun onFinishCandidatesView(finishingInput: Boolean)

onFinishInput

open override fun onFinishInput()

onFinishInputView

open fun onFinishInputView(finishingInput: Boolean)

onFinishStylusHandwriting

open fun onFinishStylusHandwriting()

onGenericMotionEvent

open fun onGenericMotionEvent(event: MotionEvent?): Boolean

onInitializeInterface

open fun onInitializeInterface()

onInlineSuggestionsResponse

open fun onInlineSuggestionsResponse(response: InlineSuggestionsResponse): Boolean

onKeyDown

open fun onKeyDown(keyCode: Int, event: KeyEvent?): Boolean

onKeyLongPress

open fun onKeyLongPress(keyCode: Int, event: KeyEvent?): Boolean

onKeyMultiple

open fun onKeyMultiple(keyCode: Int, count: Int, event: KeyEvent?): Boolean

onKeyUp

open fun onKeyUp(keyCode: Int, event: KeyEvent?): Boolean

onLowMemory

open fun onLowMemory()

onPrepareStylusHandwriting

open fun onPrepareStylusHandwriting()

onRebind

open fun onRebind(intent: Intent?)

onShouldVerifyKeyEvent

open fun onShouldVerifyKeyEvent(keyEvent: KeyEvent): Boolean

onShowInputRequested

open fun onShowInputRequested(flags: Int, configChange: Boolean): Boolean

onStart

open fun ~~onStart~~(intent: Intent?, startId: Int)

onStartCandidatesView

open fun onStartCandidatesView(editorInfo: EditorInfo?, restarting: Boolean)

onStartCommand

open fun onStartCommand(intent: Intent?, flags: Int, startId: Int): Int

onStartConnectionlessStylusHandwriting

open fun onStartConnectionlessStylusHandwriting(inputType: Int, cursorAnchorInfo: CursorAnchorInfo?): Boolean

onStartInput

open override fun onStartInput(attribute: EditorInfo?, restarting: Boolean)

onStartInputView

open fun onStartInputView(editorInfo: EditorInfo?, restarting: Boolean)

onStartStylusHandwriting

open fun onStartStylusHandwriting(): Boolean

onStylusHandwritingMotionEvent

open fun onStylusHandwritingMotionEvent(motionEvent: MotionEvent)

onTaskRemoved

open fun onTaskRemoved(rootIntent: Intent?)

onTimeout

open fun onTimeout(startId: Int)

open fun onTimeout(startId: Int, fgsType: Int)

onTrackballEvent

open fun onTrackballEvent(event: MotionEvent?): Boolean

onTrimMemory

open fun onTrimMemory(level: Int)

onUnbind

open fun onUnbind(intent: Intent?): Boolean

onUnbindInput

open fun onUnbindInput()

onUpdateCursor

open fun ~~onUpdateCursor~~(newCursor: Rect?)

onUpdateCursorAnchorInfo

open fun onUpdateCursorAnchorInfo(cursorAnchorInfo: CursorAnchorInfo?)

onUpdateEditorToolType

open fun onUpdateEditorToolType(toolType: Int)

onUpdateExtractedText

open fun onUpdateExtractedText(token: Int, text: ExtractedText?)

onUpdateExtractingViews

open fun onUpdateExtractingViews(ei: EditorInfo?)

onUpdateExtractingVisibility

open fun onUpdateExtractingVisibility(ei: EditorInfo?)

onUpdateSelection

open fun onUpdateSelection(oldSelStart: Int, oldSelEnd: Int, newSelStart: Int, newSelEnd: Int, candidatesStart: Int, candidatesEnd: Int)

onViewClicked

open fun ~~onViewClicked~~(focusChanged: Boolean)

onWindowHidden

open fun onWindowHidden()

onWindowShown

open fun onWindowShown()

openFileInput

open fun openFileInput(name: String?): FileInputStream?

openFileOutput

open fun openFileOutput(name: String?, mode: Int): FileOutputStream?

openOrCreateDatabase

open fun openOrCreateDatabase(name: String?, mode: Int, factory: SQLiteDatabase.CursorFactory?): SQLiteDatabase?

open fun openOrCreateDatabase(name: String?, mode: Int, factory: SQLiteDatabase.CursorFactory?, errorHandler: DatabaseErrorHandler?): SQLiteDatabase?

peekWallpaper

open fun ~~peekWallpaper~~(): Drawable?

registerComponentCallbacks

open fun registerComponentCallbacks(callback: ComponentCallbacks?)

registerDeviceIdChangeListener

open fun registerDeviceIdChangeListener(executor: Executor, listener: IntConsumer)

registerReceiver

open fun registerReceiver(receiver: BroadcastReceiver?, filter: IntentFilter?): Intent?

open fun registerReceiver(receiver: BroadcastReceiver?, filter: IntentFilter?, flags: Int): Intent?

open fun registerReceiver(receiver: BroadcastReceiver?, filter: IntentFilter?, broadcastPermission: String?, scheduler: Handler?): Intent?

open fun registerReceiver(receiver: BroadcastReceiver?, filter: IntentFilter?, broadcastPermission: String?, scheduler: Handler?, flags: Int): Intent?

removeStickyBroadcast

open fun ~~removeStickyBroadcast~~(intent: Intent?)

removeStickyBroadcastAsUser

open fun ~~removeStickyBroadcastAsUser~~(intent: Intent?, user: UserHandle?)

requestHideSelf

open fun requestHideSelf(flags: Int)

requestShowSelf

fun requestShowSelf(flags: Int)

revokeSelfPermissionOnKill

open fun revokeSelfPermissionOnKill(permName: String)

revokeSelfPermissionsOnKill

open fun revokeSelfPermissionsOnKill(permissions: Collection<String?>)

revokeUriPermission

open fun revokeUriPermission(uri: Uri?, modeFlags: Int)

open fun revokeUriPermission(targetPackage: String?, uri: Uri?, modeFlags: Int)

sendBroadcast

open fun sendBroadcast(intent: Intent?)

open fun sendBroadcast(intent: Intent?, receiverPermission: String?)

open fun sendBroadcast(intent: Intent, receiverPermission: String?, options: Bundle?)

sendBroadcastAsUser

open fun sendBroadcastAsUser(intent: Intent?, user: UserHandle?)

open fun sendBroadcastAsUser(intent: Intent?, user: UserHandle?, receiverPermission: String?)

sendBroadcastWithMultiplePermissions

open fun sendBroadcastWithMultiplePermissions(intent: Intent, receiverPermissions: Array<out String?>)

sendDefaultEditorAction

open fun sendDefaultEditorAction(fromEnterKey: Boolean): Boolean

sendDownUpKeyEvents

open fun sendDownUpKeyEvents(keyEventCode: Int)

sendKeyChar

open fun sendKeyChar(charCode: Char)

sendOrderedBroadcast

open fun sendOrderedBroadcast(intent: Intent?, receiverPermission: String?)

open fun sendOrderedBroadcast(intent: Intent, receiverPermission: String?, options: Bundle?)

open fun sendOrderedBroadcast(intent: Intent, receiverPermission: String?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)

open fun sendOrderedBroadcast(intent: Intent, receiverPermission: String?, options: Bundle?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)

open fun sendOrderedBroadcast(intent: Intent, receiverPermission: String?, receiverAppOp: String?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)

open fun sendOrderedBroadcast(intent: Intent, initialCode: Int, receiverPermission: String?, receiverAppOp: String?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialData: String?, initialExtras: Bundle?, options: Bundle?)

sendOrderedBroadcastAsUser

open fun sendOrderedBroadcastAsUser(intent: Intent?, user: UserHandle?, receiverPermission: String?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)

sendStickyBroadcast