droid-mcp-accessibility/io.droidmcp.accessibility/DroidMcpAccessibilityService

DroidMcpAccessibilityService

abstract class DroidMcpAccessibilityService : AccessibilityService

Abstract base service that host apps subclass to grant droid-mcp the ability to read the on-screen UI and dispatch clicks / gestures / scrolls.

The host app:

Declares a concrete subclass in its manifest with android.permission.BIND_ACCESSIBILITY_SERVICE and an <intent-filter> for android.accessibilityservice.AccessibilityService.
Points <meta-data android:name="android.accessibilityservice" android:resource="@xml/droid_mcp_accessibility_config" /> at the shipped default config (or supplies its own).
The user enables the service from Settings > Accessibility > Installed apps. The SDK exposes a helper to open that screen directly.

Subclasses MAY override onAccessibilityEvent / onInterrupt to react to events but should call super so the holder stays consistent.

Constructors

DroidMcpAccessibilityService

constructor()

Properties

accessibilityButtonController

val accessibilityButtonController: AccessibilityButtonController

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?

baseContext

open val baseContext: Context?

brailleDisplayController

val brailleDisplayController: BrailleDisplayController

cacheDir

open val cacheDir: File?

classLoader

open val classLoader: ClassLoader?

codeCacheDir

open val codeCacheDir: File?

contentResolver

open val contentResolver: ContentResolver?

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?

fingerprintGestureController

val fingerprintGestureController: FingerprintGestureController

foregroundServiceType

val foregroundServiceType: Int

inputMethod

val inputMethod: InputMethod?

isCacheEnabled

open var isCacheEnabled: Boolean

isDeviceProtectedStorage

open val isDeviceProtectedStorage: Boolean

isRestricted

open val isRestricted: Boolean

isUiContext

open val isUiContext: Boolean

magnificationController

val magnificationController: AccessibilityService.MagnificationController

mainExecutor

open val mainExecutor: Executor?

mainLooper

open val mainLooper: Looper?

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?

rootInActiveWindow

open val rootInActiveWindow: AccessibilityNodeInfo?

serviceInfo

var serviceInfo: AccessibilityServiceInfo?

softKeyboardController

val softKeyboardController: AccessibilityService.SoftKeyboardController

systemActions

val systemActions: List<AccessibilityNodeInfo.AccessibilityAction?>

theme

open val theme: Resources.Theme?

wallpaper

open val wallpaper: Drawable?

wallpaperDesiredMinimumHeight

open val wallpaperDesiredMinimumHeight: Int

wallpaperDesiredMinimumWidth

open val wallpaperDesiredMinimumWidth: Int

windows

open val windows: List<AccessibilityWindowInfo?>?

windowsOnAllDisplays

val windowsOnAllDisplays: SparseArray<List<AccessibilityWindowInfo?>?>

Functions

attachAccessibilityOverlayToDisplay

open fun attachAccessibilityOverlayToDisplay(displayId: Int, sc: SurfaceControl)

attachAccessibilityOverlayToWindow

open fun attachAccessibilityOverlayToWindow(accessibilityWindowId: Int, sc: SurfaceControl)

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

clearCache

open fun clearCache(): Boolean

clearCachedSubtree

open fun clearCachedSubtree(node: AccessibilityNodeInfo): Boolean

clearWallpaper

open fun ~~clearWallpaper~~()

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

disableSelf

fun disableSelf()

dispatchGesture

fun dispatchGesture(gesture: GestureDescription, callback: AccessibilityService.GestureResultCallback?, handler: Handler?): 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?>?

findFocus

open fun findFocus(focus: Int): AccessibilityNodeInfo?

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

getTouchInteractionController

fun getTouchInteractionController(displayId: Int): TouchInteractionController

grantUriPermission

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

isNodeInCache

open fun isNodeInCache(node: AccessibilityNodeInfo): Boolean

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

onAccessibilityEvent

open override fun onAccessibilityEvent(event: AccessibilityEvent?)

No-op by default; tools poll the tree on demand rather than reacting to events. Subclasses may override to observe events.

onBind

fun onBind(intent: Intent?): IBinder?

onConfigurationChanged

open fun onConfigurationChanged(newConfig: Configuration)

onCreate

open fun onCreate()

onCreateInputMethod

open fun onCreateInputMethod(): InputMethod

onDestroy

open override fun onDestroy()

Clears this instance from the holder on destroy. Subclasses that override MUST call super.

onGesture

open fun onGesture(gestureEvent: AccessibilityGestureEvent): Boolean

onInterrupt

open override fun onInterrupt()

No-op by default. Subclasses may override.

onLowMemory

open fun onLowMemory()

onMotionEvent

open fun onMotionEvent(event: MotionEvent)

onRebind

open fun onRebind(intent: Intent?)

onStart

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

onStartCommand

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

onSystemActionsChanged

open fun onSystemActionsChanged()

onTaskRemoved

open fun onTaskRemoved(rootIntent: Intent?)

onTimeout

open fun onTimeout(startId: Int)

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

onTrimMemory

open fun onTrimMemory(level: Int)

onUnbind

open override fun onUnbind(intent: Intent?): Boolean

Clears this instance from the holder on unbind. Subclasses that override MUST call super.

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?

performGlobalAction

fun performGlobalAction(action: Int): Boolean

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?)

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?>)

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