Added in API level 3

InputMethodService


open class InputMethodService : AbstractInputMethodService

InputMethodService provides a standard implementation of an InputMethod, which final implementations can derive from and customize. See the base class AbstractInputMethodService and the InputMethod interface for more information on the basics of writing input methods.

In addition to the normal Service lifecycle methods, this class introduces some new specific callbacks that most subclasses will want to make use of:

An input method has significant discretion in how it goes about its work: the android.inputmethodservice.InputMethodService provides a basic framework for standard UI elements (input view, candidates view, and running in fullscreen mode), but it is up to a particular implementor to decide how to use them. For example, one input method could implement an input area with a keyboard, another could allow the user to draw text, while a third could have no input area (and thus not be visible to the user) but instead listen to audio and perform text to speech conversion.

In the implementation provided here, all of these elements are placed together in a single window managed by the InputMethodService. It will execute callbacks as it needs information about them, and provides APIs for programmatic control over them. They layout of these elements is explicitly defined:

  • The soft input view, if available, is placed at the bottom of the screen.
  • The candidates view, if currently shown, is placed above the soft input view.
  • If not running fullscreen, the application is moved or resized to be above these views; if running fullscreen, the window will completely cover the application and its top part will contain the extract text of what is currently being edited by the application.

Soft Input View

Central to most input methods is the soft input view. This is where most user interaction occurs: pressing on soft keys, drawing characters, or however else your input method wants to generate text. Most implementations will simply have their own view doing all of this work, and return a new instance of it when onCreateInputView() is called. At that point, as long as the input view is visible, you will see user interaction in that view and can call back on the InputMethodService to interact with the application as appropriate.

There are some situations where you want to decide whether or not your soft input view should be shown to the user. This is done by implementing the onEvaluateInputViewShown() to return true or false based on whether it should be shown in the current environment. If any of your state has changed that may impact this, call updateInputViewShown() to have it re-evaluated. The default implementation always shows the input view unless there is a hard keyboard available, which is the appropriate behavior for most input methods.

Candidates View

Often while the user is generating raw text, an input method wants to provide them with a list of possible interpretations of that text that can be selected for use. This is accomplished with the candidates view, and like the soft input view you implement onCreateCandidatesView() to instantiate your own view implementing your candidates UI.

Management of the candidates view is a little different than the input view, because the candidates view tends to be more transient, being shown only when there are possible candidates for the current text being entered by the user. To control whether the candidates view is shown, you use setCandidatesViewShown(boolean). Note that because the candidate view tends to be shown and hidden a lot, it does not impact the application UI in the same way as the soft input view: it will never cause application windows to resize, only cause them to be panned if needed for the user to see the current focus.

Fullscreen Mode

Sometimes your input method UI is too large to integrate with the application UI, so you just want to take over the screen. This is accomplished by switching to full-screen mode, causing the input method window to fill the entire screen and add its own "extracted text" editor showing the user the text that is being typed. Unlike the other UI elements, there is a standard implementation for the extract editor that you should not need to change. The editor is placed at the top of the IME, above the input and candidates views.

Similar to the input view, you control whether the IME is running in fullscreen mode by implementing onEvaluateFullscreenMode() to return true or false based on whether it should be fullscreen in the current environment. If any of your state has changed that may impact this, call updateFullscreenMode() to have it re-evaluated. The default implementation selects fullscreen mode when the screen is in a landscape orientation, which is appropriate behavior for most input methods that have a significant input area.

When in fullscreen mode, you have some special requirements because the user can not see the application UI. In particular, you should implement onDisplayCompletions(android.view.inputmethod.CompletionInfo[]) to show completions generated by your application, typically in your candidates view like you would normally show candidates.

Generating Text

The key part of an IME is of course generating text for the application. This is done through calls to the android.view.inputmethod.InputConnection interface to the application, which can be retrieved from getCurrentInputConnection(). This interface allows you to generate raw key events or, if the target supports it, directly edit in strings of candidates and committed text.

Information about what the target is expected and supports can be found through the android.view.inputmethod.EditorInfo class, which is retrieved with getCurrentInputEditorInfo() method. The most important part of this is EditorInfo.inputType; in particular, if this is EditorInfo.TYPE_NULL, then the target does not support complex edits and you need to only deliver raw key events to it. An input method will also want to look at other values here, to for example detect password mode, auto complete text views, phone number entry, etc.

When the user switches between input targets, you will receive calls to onFinishInput() and onStartInput(android.view.inputmethod.EditorInfo,boolean). You can use these to reset and initialize your input state for the current target. For example, you will often want to clear any input state, and update a soft keyboard to be appropriate for the new inputType.

Summary

Nested classes
open

Concrete implementation of AbstractInputMethodService.AbstractInputMethodImpl that provides all of the standard behavior for an input method.

open

Concrete implementation of AbstractInputMethodService.AbstractInputMethodSessionImpl that provides all of the standard behavior for an input method session.

Information about where interesting parts of the input method UI appear.

XML attributes
android:imeExtractEnterAnimation Animation to use when showing the fullscreen extract UI after it had previously been hidden.
android:imeExtractExitAnimation Animation to use when hiding the fullscreen extract UI after it had previously been shown.
android:imeFullscreenBackground Background to use for entire input method when it is being shown in fullscreen mode with the extract view, to ensure that it completely covers the application.
Constants
static Int

Asks the system to not adjust the back button affordance even when the software keyboard is shown.

static Int

Allows the system to optimize the back button affordance based on the presence of software keyboard.

static Int

Deprecated flag.

static Int

Deprecated flag.

Inherited constants
String ACCESSIBILITY_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.view.accessibility.AccessibilityManager for giving the user feedback for UI events through the registered event listeners.

String ACCOUNT_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.accounts.AccountManager for receiving intents at a time of your choosing.

String ACTIVITY_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.app.ActivityManager for interacting with the global system state.

String ADVANCED_PROTECTION_SERVICE

Use with getSystemService(java.lang.String) to retrieve an android.security.advancedprotection.AdvancedProtectionManager

String ALARM_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.app.AlarmManager for receiving intents at a time of your choosing.

String APPWIDGET_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.appwidget.AppWidgetManager for accessing AppWidgets.

String APP_FUNCTION_SERVICE

Use with getSystemService(java.lang.String) to retrieve an AppFunctionManager for executing app functions.

String APP_OPS_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.app.AppOpsManager for tracking application operations on the device.

String APP_SEARCH_SERVICE

Use with getSystemService(java.lang.String) to retrieve an android.app.appsearch.AppSearchManager for indexing and querying app data managed by the system.

String AUDIO_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.media.AudioManager for handling management of volume, ringer modes and audio routing.

String BATTERY_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.os.BatteryManager for managing battery state.

Int BIND_ABOVE_CLIENT

Flag for #bindService: indicates that the client application binding to this service considers the service to be more important than the app itself. When set, the platform will try to have the out of memory killer kill the app before it kills the service it is bound to, though this is not guaranteed to be the case.

Int BIND_ADJUST_WITH_ACTIVITY

Flag for #bindService: If binding from an activity, allow the target service's process importance to be raised based on whether the activity is visible to the user, regardless whether another flag is used to reduce the amount that the client process's overall importance is used to impact it.

Int BIND_ALLOW_ACTIVITY_STARTS

Flag for #bindService: If binding from an app that is visible, the bound service is allowed to start an activity from background. This was the default behavior before SDK version android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE. Since then, the default behavior changed to disallow the bound service to start a background activity even if the app bound to it is in foreground, unless this flag is specified when binding.

Int BIND_ALLOW_OOM_MANAGEMENT

Flag for #bindService: allow the process hosting the bound service to go through its normal memory management. It will be treated more like a running service, allowing the system to (temporarily) expunge the process if low on memory or for some other whim it may have, and being more aggressive about making it a candidate to be killed (and restarted) if running for a long time.

Int BIND_AUTO_CREATE

Flag for #bindService: automatically create the service as long as the binding exists. Note that while this will create the service, its android.app.Service#onStartCommand method will still only be called due to an explicit call to startService. Even without that, though, this still provides you with access to the service object while the service is created.

Note that prior to android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH, not supplying this flag would also impact how important the system consider's the target service's process to be. When set, the only way for it to be raised was by binding from a service in which case it will only be important when that activity is in the foreground. Now to achieve this behavior you must explicitly supply the new flag BIND_ADJUST_WITH_ACTIVITY. For compatibility, old applications that don't specify BIND_AUTO_CREATE will automatically have the flags BIND_WAIVE_PRIORITY and BIND_ADJUST_WITH_ACTIVITY set for them in order to achieve the same result.

Int BIND_DEBUG_UNBIND

Flag for #bindService: include debugging help for mismatched calls to unbind. When this flag is set, the callstack of the following unbindService call is retained, to be printed if a later incorrect unbind call is made. Note that doing this requires retaining information about the binding that was made for the lifetime of the app, resulting in a leak -- this should only be used for debugging.

Int BIND_EXTERNAL_SERVICE

Flag for #bindService: The service being bound is an isolated, external service. This binds the service into the calling application's package, rather than the package in which the service is declared.

When using this flag, the code for the service being bound will execute under the calling application's package name and user ID. Because the service must be an isolated process, it will not have direct access to the application's data, though. The purpose of this flag is to allow applications to provide services that are attributed to the app using the service, rather than the application providing the service.

This flag is NOT compatible with BindServiceFlags. If you need to use BindServiceFlags, you must use BIND_EXTERNAL_SERVICE_LONG instead.

Long BIND_EXTERNAL_SERVICE_LONG

Works in the same way as BIND_EXTERNAL_SERVICE, but it's defined as a long value that is compatible to BindServiceFlags.

Int BIND_IMPORTANT

Flag for #bindService: this service is very important to the client, so should be brought to the foreground process level when the client is. Normally a process can only be raised to the visibility level by a client, even if that client is in the foreground.

Int BIND_INCLUDE_CAPABILITIES

Flag for #bindService: If binding from an app that has specific capabilities due to its foreground state such as an activity or foreground service, then this flag will allow the bound app to get the same capabilities, as long as it has the required permissions as well. If binding from a top app and its target SDK version is at or above android.os.Build.VERSION_CODES#R, the app needs to explicitly use BIND_INCLUDE_CAPABILITIES flag to pass all capabilities to the service so the other app can have while-in-use access such as location, camera, microphone from background. If binding from a top app and its target SDK version is below android.os.Build.VERSION_CODES#R, BIND_INCLUDE_CAPABILITIES is implicit.

Int BIND_NOT_FOREGROUND

Flag for #bindService: don't allow this binding to raise the target service's process to the foreground scheduling priority. It will still be raised to at least the same memory priority as the client (so that its process will not be killable in any situation where the client is not killable), but for CPU scheduling purposes it may be left in the background. This only has an impact in the situation where the binding client is a foreground process and the target service is in a background process.

Int BIND_NOT_PERCEPTIBLE

Flag for #bindService: If binding from an app that is visible or user-perceptible, lower the target service's importance to below the perceptible level. This allows the system to (temporarily) expunge the bound process from memory to make room for more important user-perceptible processes.

Int BIND_PACKAGE_ISOLATED_PROCESS

Flag for #bindIsolatedService: Bind the service into a shared isolated process, but only with other isolated services from the same package that declare the same process name.

Specifying this flag allows multiple isolated services defined in the same package to be running in a single shared isolated process. This shared isolated process must be specified since this flag will not work with the default application process.

This flag is different from BIND_SHARED_ISOLATED_PROCESS since it only allows binding services from the same package in the same shared isolated process. This also means the shared package isolated process is global, and not scoped to each potential calling app.

The shared isolated process instance is identified by the "android:process" attribute defined by the service. This flag cannot be used without this attribute set.

Int BIND_SHARED_ISOLATED_PROCESS

Flag for #bindIsolatedService: Bind the service into a shared isolated process. Specifying this flag allows multiple isolated services to be running in a single shared isolated process. The shared isolated process instance is identified by the instanceName parameter in bindIsolatedService(android.content.Intent,int,java.lang.String,java.util.concurrent.Executor,android.content.ServiceConnection). Subsequent calls to #bindIsolatedService with the same instanceName will cause the isolated service to be co-located in the same shared isolated process. Note that the shared isolated process is scoped to the calling app; once created, only the calling app can bind additional isolated services into the shared process. However, the services themselves can come from different APKs and therefore different vendors. Only services that set the android.R.attr#allowSharedIsolatedProcess attribute to true are allowed to be bound into a shared isolated process.

Int BIND_WAIVE_PRIORITY

Flag for #bindService: don't impact the scheduling or memory management priority of the target service's hosting process. Allows the service's process to be managed on the background LRU list just like a regular application process in the background.

String BIOMETRIC_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.hardware.biometrics.BiometricManager for handling biometric and PIN/pattern/password authentication.

String BLOB_STORE_SERVICE

Use with getSystemService(java.lang.String) to retrieve a for contributing and accessing data blobs from the blob store maintained by the system.

String BLUETOOTH_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.bluetooth.BluetoothManager for using Bluetooth.

String BUGREPORT_SERVICE

Service to capture a bugreport.

String CAMERA_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.hardware.camera2.CameraManager for interacting with camera devices.

String CAPTIONING_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.view.accessibility.CaptioningManager for obtaining captioning properties and listening for changes in captioning preferences.

String CARRIER_CONFIG_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.telephony.CarrierConfigManager for reading carrier configuration values.

String CLIPBOARD_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.content.ClipboardManager for accessing and modifying the contents of the global clipboard.

String COMPANION_DEVICE_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.companion.CompanionDeviceManager for managing companion devices

String CONNECTIVITY_DIAGNOSTICS_SERVICE

Use with getSystemService(java.lang.String) to retrieve a for performing network connectivity diagnostics as well as receiving network connectivity information from the system.

String CONNECTIVITY_SERVICE

Use with getSystemService(java.lang.String) to retrieve a for handling management of network connections.

String CONSUMER_IR_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.hardware.ConsumerIrManager for transmitting infrared signals from the device.

String CONTACT_KEYS_SERVICE

Use with getSystemService(java.lang.String) to retrieve a E2eeContactKeysManager to managing contact keys.

Int CONTEXT_IGNORE_SECURITY

Flag for use with createPackageContext: ignore any security restrictions on the Context being requested, allowing it to always be loaded. For use with CONTEXT_INCLUDE_CODE to allow code to be loaded into a process even when it isn't safe to do so. Use with extreme care!

Int CONTEXT_INCLUDE_CODE

Flag for use with createPackageContext: include the application code with the context. This means loading code into the caller's process, so that getClassLoader() can be used to instantiate the application's classes. Setting this flags imposes security restrictions on what application context you can access; if the requested application can not be safely loaded into your process, java.lang.SecurityException will be thrown. If this flag is not set, there will be no restrictions on the packages that can be loaded, but getClassLoader will always return the default system class loader.

Int CONTEXT_RESTRICTED

Flag for use with createPackageContext: a restricted context may disable specific features. For instance, a View associated with a restricted context would ignore particular XML attributes.

String CREDENTIAL_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.credentials.CredentialManager to authenticate a user to your app.

String CROSS_PROFILE_APPS_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.content.pm.CrossProfileApps for cross profile operations.

Int DEVICE_ID_DEFAULT

The default device ID, which is the ID of the primary (non-virtual) device.

Int DEVICE_ID_INVALID

Invalid device ID.

String DEVICE_LOCK_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.devicelock.DeviceLockManager.

String DEVICE_POLICY_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.app.admin.DevicePolicyManager for working with global device policy management.

String DISPLAY_HASH_SERVICE

Use with getSystemService(java.lang.String) to access android.view.displayhash.DisplayHashManager to handle display hashes.

String DISPLAY_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.hardware.display.DisplayManager for interacting with display devices.

String DOMAIN_VERIFICATION_SERVICE

Use with getSystemService(java.lang.String) to access android.content.pm.verify.domain.DomainVerificationManager to retrieve approval and user state for declared web domains.

String DOWNLOAD_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.app.DownloadManager for requesting HTTP downloads.

String DROPBOX_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.os.DropBoxManager instance for recording diagnostic logs.

String EUICC_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.telephony.euicc.EuiccManager to manage the device eUICC (embedded SIM).

String FILE_INTEGRITY_SERVICE

Use with getSystemService(java.lang.String) to retrieve an android.security.FileIntegrityManager.

String FINGERPRINT_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.hardware.fingerprint.FingerprintManager for handling management of fingerprints.

String GAME_SERVICE

Use with getSystemService(java.lang.String) to retrieve a GameManager.

String GRAMMATICAL_INFLECTION_SERVICE

Use with getSystemService(java.lang.String) to retrieve a GrammaticalInflectionManager.

String HARDWARE_PROPERTIES_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.os.HardwarePropertiesManager for accessing the hardware properties service.

String HEALTHCONNECT_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.health.connect.HealthConnectManager.

String INPUT_METHOD_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.view.inputmethod.InputMethodManager for accessing input methods.

String INPUT_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.hardware.input.InputManager for interacting with input devices.

String IPSEC_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.net.IpSecManager for encrypting Sockets or Networks with IPSec.

String JOB_SCHEDULER_SERVICE

Use with getSystemService(java.lang.String) to retrieve a instance for managing occasional background tasks.

String KEYGUARD_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.app.KeyguardManager for controlling keyguard.

String KEYSTORE_SERVICE

Use with getSystemService(java.lang.String) to retrieve a for accessing Android Keystore functions.

String LAUNCHER_APPS_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.content.pm.LauncherApps for querying and monitoring launchable apps across profiles of a user.

String LAYOUT_INFLATER_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.view.LayoutInflater for inflating layout resources in this context.

String LOCALE_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.app.LocaleManager.

String LOCATION_SERVICE

Use with getSystemService(java.lang.String) to retrieve a for controlling location updates.

String MEDIA_COMMUNICATION_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.media.MediaCommunicationManager for managing android.media.MediaSession2.

String MEDIA_METRICS_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.media.metrics.MediaMetricsManager for interacting with media metrics on the device.

String MEDIA_PROJECTION_SERVICE

Use with getSystemService(java.lang.String) to retrieve a instance for managing media projection sessions.

String MEDIA_QUALITY_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.media.quality.MediaQuality for standardize picture and audio API parameters.

String MEDIA_ROUTER_SERVICE

Use with #getSystemService to retrieve a android.media.MediaRouter for controlling and managing routing of media.

String MEDIA_SESSION_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.media.session.MediaSessionManager for managing media Sessions.

String MIDI_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.media.midi.MidiManager for accessing the MIDI service.

Int MODE_APPEND

File creation mode: for use with openFileOutput, if the file already exists then write data to the end of the existing file instead of erasing it.

Int MODE_ENABLE_WRITE_AHEAD_LOGGING

Database open flag: when set, the database is opened with write-ahead logging enabled by default.

Int MODE_MULTI_PROCESS

SharedPreference loading flag: when set, the file on disk will be checked for modification even if the shared preferences instance is already loaded in this process. This behavior is sometimes desired in cases where the application has multiple processes, all writing to the same SharedPreferences file. Generally there are better forms of communication between processes, though.

This was the legacy (but undocumented) behavior in and before Gingerbread (Android 2.3) and this flag is implied when targeting such releases. For applications targeting SDK versions greater than Android 2.3, this flag must be explicitly set if desired.

Int MODE_NO_LOCALIZED_COLLATORS

Database open flag: when set, the database is opened without support for localized collators.

Int MODE_PRIVATE

File creation mode: the default mode, where the created file can only be accessed by the calling application (or all applications sharing the same user ID).

Int MODE_WORLD_READABLE

File creation mode: allow all other applications to have read access to the created file.

Starting from android.os.Build.VERSION_CODES#N, attempting to use this mode throws a SecurityException.

Int MODE_WORLD_WRITEABLE

File creation mode: allow all other applications to have write access to the created file.

Starting from android.os.Build.VERSION_CODES#N, attempting to use this mode will throw a SecurityException.

String NETWORK_STATS_SERVICE

Use with getSystemService(java.lang.String) to retrieve a for querying network usage stats.

String NFC_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.nfc.NfcManager for using NFC.

String NOTIFICATION_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.app.NotificationManager for informing the user of background events.

String NSD_SERVICE

Use with getSystemService(java.lang.String) to retrieve a for handling management of network service discovery

String OVERLAY_SERVICE

Use with getSystemService(java.lang.String) to retrieve a for managing overlay packages.

String PEOPLE_SERVICE

Use with getSystemService(java.lang.String) to access a PeopleManager to interact with your published conversations.

String PERFORMANCE_HINT_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.os.PerformanceHintManager for accessing the performance hinting service.

String PERSISTENT_DATA_BLOCK_SERVICE

Use with getSystemService(java.lang.String) to retrieve a instance for interacting with a storage device that lives across factory resets.

String POWER_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.os.PowerManager for controlling power management, including "wake locks," which let you keep the device on while you're running long tasks.

String PRINT_SERVICE

android.print.PrintManager for printing and managing printers and print tasks.

String PROFILING_SERVICE

Use with getSystemService(java.lang.String) to retrieve an android.os.ProfilingManager.

Int RECEIVER_EXPORTED

Flag for #registerReceiver: The receiver can receive broadcasts from other Apps. Has the same behavior as marking a statically registered receiver with "exported=true"

Int RECEIVER_NOT_EXPORTED

Flag for #registerReceiver: The receiver cannot receive broadcasts from other Apps. Has the same behavior as marking a statically registered receiver with "exported=false"

Int RECEIVER_VISIBLE_TO_INSTANT_APPS

Flag for #registerReceiver: The receiver can receive broadcasts from Instant Apps.

String RESTRICTIONS_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.content.RestrictionsManager for retrieving application restrictions and requesting permissions for restricted operations.

String ROLE_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.app.role.RoleManager for managing roles.

String SATELLITE_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.telephony.satellite.SatelliteManager for accessing satellite functionality.

String SEARCH_SERVICE

Use with getSystemService(java.lang.String) to retrieve a for handling searches.

Configuration.UI_MODE_TYPE_WATCH does not support android.app.SearchManager.

String SECURITY_STATE_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.os.SecurityStateManager for accessing the security state manager service.

String SENSOR_SERVICE

Use with getSystemService(java.lang.String) to retrieve a for accessing sensors.

String SHORTCUT_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.content.pm.ShortcutManager for accessing the launcher shortcut service.

String STATUS_BAR_SERVICE

Use with getSystemService(java.lang.String) to retrieve a for interacting with the status bar and quick settings.

String STORAGE_SERVICE

Use with getSystemService(java.lang.String) to retrieve a for accessing system storage functions.

String STORAGE_STATS_SERVICE

Use with getSystemService(java.lang.String) to retrieve a for accessing system storage statistics.

String SYSTEM_HEALTH_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.os.health.SystemHealthManager for accessing system health (battery, power, memory, etc) metrics.

String TELECOM_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.telecom.TelecomManager to manage telecom-related features of the device.

String TELEPHONY_IMS_SERVICE

Use with getSystemService(java.lang.String) to retrieve an android.telephony.ims.ImsManager.

String TELEPHONY_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.telephony.TelephonyManager for handling management the telephony features of the device.

String TELEPHONY_SUBSCRIPTION_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.telephony.SubscriptionManager for handling management the telephony subscriptions of the device.

String TEXT_CLASSIFICATION_SERVICE

Use with getSystemService(java.lang.String) to retrieve a TextClassificationManager for text classification services.

String TEXT_SERVICES_MANAGER_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.view.textservice.TextServicesManager for accessing text services.

String TV_AD_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.media.tv.ad.TvAdManager for interacting with TV client-side advertisement services on the device.

String TV_INPUT_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.media.tv.TvInputManager for interacting with TV inputs on the device.

String TV_INTERACTIVE_APP_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.media.tv.interactive.TvInteractiveAppManager for interacting with TV interactive applications on the device.

String UI_MODE_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.app.UiModeManager for controlling UI modes.

String USAGE_STATS_SERVICE

Use with getSystemService(java.lang.String) to retrieve a for querying device usage stats.

String USB_SERVICE

Use with getSystemService(java.lang.String) to retrieve a for access to USB devices (as a USB host) and for controlling this device's behavior as a USB device.

String USER_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.os.UserManager for managing users on devices that support multiple users.

String VIBRATOR_MANAGER_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.os.VibratorManager for accessing the device vibrators, interacting with individual ones and playing synchronized effects on multiple vibrators.

String VIBRATOR_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.os.Vibrator for interacting with the vibration hardware.

String VIRTUAL_DEVICE_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.companion.virtual.VirtualDeviceManager for managing virtual devices. On devices without PackageManager.FEATURE_COMPANION_DEVICE_SETUP system feature the getSystemService(java.lang.String) will return null.

String VPN_MANAGEMENT_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.net.VpnManager to manage profiles for the platform built-in VPN.

String WALLPAPER_SERVICE

Use with getSystemService(java.lang.String) to retrieve a com.android.server.WallpaperService for accessing wallpapers.

String WIFI_AWARE_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.net.wifi.aware.WifiAwareManager for handling management of Wi-Fi Aware.

String WIFI_P2P_SERVICE

Use with getSystemService(java.lang.String) to retrieve a for handling management of Wi-Fi peer-to-peer connections.

String WIFI_RTT_RANGING_SERVICE

Use with getSystemService(java.lang.String) to retrieve a for ranging devices with wifi.

String WIFI_SERVICE

Use with getSystemService(java.lang.String) to retrieve a for handling management of Wi-Fi access.

String WINDOW_SERVICE

Use with getSystemService(java.lang.String) to retrieve a android.view.WindowManager for accessing the system's window manager.

Int START_CONTINUATION_MASK

Bits returned by onStartCommand describing how to continue the service if it is killed. May be START_STICKY, START_NOT_STICKY, START_REDELIVER_INTENT, or START_STICKY_COMPATIBILITY.

Int START_FLAG_REDELIVERY

This flag is set in onStartCommand if the Intent is a re-delivery of a previously delivered intent, because the service had previously returned START_REDELIVER_INTENT but had been killed before calling stopSelf(int) for that Intent.

Int START_FLAG_RETRY

This flag is set in onStartCommand if the Intent is a retry because the original attempt never got to or returned from onStartCommand(android.content.Intent,int,int).

Int START_NOT_STICKY

Constant to return from onStartCommand: if this service's process is killed while it is started (after returning from onStartCommand), and there are no new start intents to deliver to it, then take the service out of the started state and don't recreate until a future explicit call to Context.startService(Intent). The service will not receive a onStartCommand(android.content.Intent,int,int) call with a null Intent because it will not be restarted if there are no pending Intents to deliver.

This mode makes sense for things that want to do some work as a result of being started, but can be stopped when under memory pressure and will explicit start themselves again later to do more work. An example of such a service would be one that polls for data from a server: it could schedule an alarm to poll every N minutes by having the alarm start its service. When its onStartCommand is called from the alarm, it schedules a new alarm for N minutes later, and spawns a thread to do its networking. If its process is killed while doing that check, the service will not be restarted until the alarm goes off.

Int START_REDELIVER_INTENT

Constant to return from onStartCommand: if this service's process is killed while it is started (after returning from onStartCommand), then it will be scheduled for a restart and the last delivered Intent re-delivered to it again via onStartCommand. This Intent will remain scheduled for redelivery until the service calls stopSelf(int) with the start ID provided to onStartCommand. The service will not receive a onStartCommand(android.content.Intent,int,int) call with a null Intent because it will only be restarted if it is not finished processing all Intents sent to it (and any such pending events will be delivered at the point of restart).

Int START_STICKY

Constant to return from onStartCommand: if this service's process is killed while it is started (after returning from onStartCommand), then leave it in the started state but don't retain this delivered intent. Later the system will try to re-create the service. Because it is in the started state, it will guarantee to call onStartCommand after creating the new service instance; if there are not any pending start commands to be delivered to the service, it will be called with a null intent object, so you must take care to check for this.

This mode makes sense for things that will be explicitly started and stopped to run for arbitrary periods of time, such as a service performing background music playback.

Since Android version Build.VERSION_CODES.S, apps targeting Build.VERSION_CODES.S or above are disallowed to start a foreground service from the background, but the restriction doesn't impact restarts of a sticky foreground service. However, when apps start a sticky foreground service from the background, the same restriction still applies.

Int START_STICKY_COMPATIBILITY

Constant to return from onStartCommand: compatibility version of START_STICKY that does not guarantee that onStartCommand will be called again after being killed.

Int STOP_FOREGROUND_DETACH

Selector for stopForeground(int): if set, the notification previously supplied to #startForeground will be detached from the service's lifecycle. The notification will remain shown even after the service is stopped and destroyed.

Int STOP_FOREGROUND_LEGACY

Selector for stopForeground(int): equivalent to passing false to the legacy API stopForeground(boolean).

Int STOP_FOREGROUND_REMOVE

Selector for stopForeground(int): if supplied, the notification previously supplied to #startForeground will be cancelled and removed from display.

Int TRIM_MEMORY_BACKGROUND

Level for onTrimMemory(int): the process has gone on to the LRU list. This is a good opportunity to clean up resources that can efficiently and quickly be re-built if the user returns to the app.

Int TRIM_MEMORY_COMPLETE

Level for onTrimMemory(int): the process is nearing the end of the background LRU list, and if more memory isn't found soon it will be killed.

Int TRIM_MEMORY_MODERATE

Level for onTrimMemory(int): the process is around the middle of the background LRU list; freeing memory can help the system keep other processes running later in the list for better overall performance.

Int TRIM_MEMORY_RUNNING_CRITICAL

Level for onTrimMemory(int): the process is not an expendable background process, but the device is running extremely low on memory and is about to not be able to keep any background processes running. Your running process should free up as many non-critical resources as it can to allow that memory to be used elsewhere. The next thing that will happen after this is onLowMemory() called to report that nothing at all can be kept in the background, a situation that can start to notably impact the user.

Int TRIM_MEMORY_RUNNING_LOW

Level for onTrimMemory(int): the process is not an expendable background process, but the device is running low on memory. Your running process should free up unneeded resources to allow that memory to be used elsewhere.

Int TRIM_MEMORY_RUNNING_MODERATE

Level for onTrimMemory(int): the process is not an expendable background process, but the device is running moderately low on memory. Your running process may want to release some unneeded resources for use elsewhere.

Int TRIM_MEMORY_UI_HIDDEN

Level for onTrimMemory(int): the process had been showing a user interface, and is no longer doing so. Large allocations with the UI should be released at this point to allow memory to be better managed.

Public constructors

Public methods
open Boolean

You can call this to try to enable accelerated drawing for your IME.

Unit

Finishes the current connectionless stylus handwriting session and delivers the result.

Unit

Finish the current stylus handwriting session.

open Int

Retrieves the current disposition mode that indicates the expected back button affordance.

open Int

Returns the visibility mode (either View.INVISIBLE or View.GONE) of the candidates view when it is not shown.

open InputBinding!

Return the currently active InputBinding for the input method, or null if there is none.

open InputConnection!

Retrieve the currently active InputConnection that is bound to the input method, or null if there is none.

open EditorInfo!

open Boolean

open Int

Aimed to return the previous input method's Insets.contentTopInsets, but its actual semantics has never been well defined.

open LayoutInflater!

open Int

Return the maximum width, in pixels, available the input method.

static Duration

Returns the maximum stylus handwriting session idle-timeout for use with setStylusHandwritingSessionTimeout(java.time.Duration).

Duration

Returns the duration after which an ongoing stylus handwriting session that hasn't received new MotionEvents will time out and finishStylusHandwriting() will be called.

Window?

Returns the stylus handwriting inking window.

open Any?

Return the handle to a system-level service by name.

open CharSequence!
getTextForImeAction(imeOptions: Int)

Return text that can be used as a button label for the given EditorInfo.imeOptions.

open Dialog!

open Unit

open Unit

open Boolean

Return whether the fullscreen extract view is shown.

open Boolean

Return whether the input method is currently running in fullscreen mode.

open Boolean

Return whether the soft input view is currently shown to the user.

open Boolean

Returns true if we have been asked to show our input view.

open Unit
onAppPrivateCommand(action: String!, data: Bundle!)

Not implemented in this class.

open Unit

Called when a new client has bound to the input method.

open Unit

Compute the interesting insets into your UI.

open Unit

Take care of handling configuration changes.

open Unit
onConfigureWindow(win: Window!, isFullscreen: Boolean, isCandidatesOnly: Boolean)

Update the given window's parameters for the given mode.

open Unit

open View!

Create and return the view hierarchy used to show candidates.

open View!

Called by the framework to create the layout for showing extracted text.

open InlineSuggestionsRequest?

Called when Autofill is requesting an InlineSuggestionsRequest from the IME.

open AbstractInputMethodService.AbstractInputMethodImpl!

Implement to return our standard InputMethodImpl.

open AbstractInputMethodService.AbstractInputMethodSessionImpl!

Implement to return our standard InputMethodSessionImpl.

open View!

Create and return the view hierarchy used for the input area (such as a soft keyboard).

open Unit

Called when the requested visibility of a custom IME Switcher button changes.

open Unit

open Unit

Called when the application has reported auto-completion candidates that it would like to have the input method displayed.

open Boolean

Override this to control when the input method should run in fullscreen mode.

open Boolean

Override this to control when the soft input area should be shown to the user.

open Boolean

This is called when the user has selected a context menu item from the extracted text view, when running in fullscreen mode.

open Unit

This is called when the user has performed a cursor movement in the extracted text view, when it is running in fullscreen mode.

open Unit

This is called when the user has moved the cursor in the extracted text view, when running in fullsreen mode.

open Unit

This is called when the user has clicked on the extracted text view, when running in fullscreen mode.

open Unit

This is called when, while currently displayed in extract mode, the current input target changes.

open Unit

Called when the candidates view is being hidden from the user.

open Unit

Called to inform the input method that text input has finished in the last editor.

open Unit
onFinishInputView(finishingInput: Boolean)

Called when the input view is being hidden from the user.

open Unit

Called when the current stylus handwriting session was finished (either by the system or via finishStylusHandwriting().

open Boolean

Override this to intercept generic motion events before they are processed by the application.

open Unit

This is a hook that subclasses can use to perform initialization of their interface.

open Boolean

Called when Autofill responds back with InlineSuggestionsResponse containing inline suggestions.

open Boolean
onKeyDown(keyCode: Int, event: KeyEvent!)

Called back when a KeyEvent is forwarded from the target application.

open Boolean
onKeyLongPress(keyCode: Int, event: KeyEvent!)

Default implementation of KeyEvent.Callback.onKeyLongPress(): always returns false (doesn't handle the event).

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

Override this to intercept special key multiple events before they are processed by the application.

open Boolean
onKeyUp(keyCode: Int, event: KeyEvent!)

Override this to intercept key up events before they are processed by the application.

open Unit

Called to prepare stylus handwriting.

open Boolean

Received by the IME before dispatch to onKeyDown(int,android.view.KeyEvent) to let the system know if the KeyEvent needs to be verified that it originated from the system.

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

The system has decided that it may be time to show your input method.

open Unit
onStartCandidatesView(editorInfo: EditorInfo!, restarting: Boolean)

Called when only the candidates view has been shown for showing processing as the user enters text through a hard keyboard.

open Boolean

Called when an app requests to start a connectionless stylus handwriting session using one of InputMethodManager.startConnectionlessStylusHandwriting(View, CursorAnchorInfo,, android.view.inputmethod.InputMethodManager#startConnectionlessStylusHandwritingForDelegation(android.view.View,android.view.inputmethod.CursorAnchorInfo,java.util.concurrent.Executor,android.view.inputmethod.ConnectionlessHandwritingCallback), or android.view.inputmethod.InputMethodManager#startConnectionlessStylusHandwritingForDelegation(android.view.View,android.view.inputmethod.CursorAnchorInfo,java.lang.String,java.util.concurrent.Executor,android.view.inputmethod.ConnectionlessHandwritingCallback).

open Unit
onStartInput(attribute: EditorInfo!, restarting: Boolean)

Called to inform the input method that text input has started in an editor.

open Unit
onStartInputView(editorInfo: EditorInfo!, restarting: Boolean)

Called when the input view is being shown and input has started on a new editor.

open Boolean

Called when an app requests stylus handwriting InputMethodManager.startStylusHandwriting(View).

open Unit

Called after onStartStylusHandwriting() returns true for every Stylus MotionEvent.

open Boolean

Override this to intercept trackball motion events before they are processed by the application.

open Unit

Called when the previous bound client is no longer associated with the input method.

open Unit
onUpdateCursor(newCursor: Rect!)

Called when the application has reported a new location of its text cursor.

open Unit

Called when the application has reported a new location of its text insertion point and characters in the composition string.

open Unit

Called when the user tapped or clicked an editor.

open Unit

Called when the application has reported new extracted text to be shown due to changes in its current text state.

open Unit

Called when the fullscreen-mode extracting editor info has changed, to update the state of its UI such as the action buttons shown.

open Unit

Called when the fullscreen-mode extracting editor info has changed, to determine whether the extracting (extract text and candidates) portion of the UI should be shown.

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

Called when the application has reported a new selection region of the text.

open Unit
onViewClicked(focusChanged: Boolean)

Called when the user tapped or clicked a text view.

open Unit

Called when the input method window has been hidden from the user, after previously being visible.

open Unit

Called immediately before the input method window is shown to the user.

open Unit

Close this input method's soft input area, removing it from the display.

Unit

Show the input method's soft input area, so the user sees the input method window and can interact with it.

open Boolean

Ask the input target to execute its default action via InputConnection.performEditorAction().

open Unit
sendDownUpKeyEvents(keyEventCode: Int)

Send the given key event code (as defined by KeyEvent) to the current input connection is a key down + key up event pair.

open Unit
sendKeyChar(charCode: Char)

Send the given UTF-16 character to the current input connection.

open Unit
setBackDisposition(disposition: Int)

Sets the disposition mode that indicates the expected affordance for the back button.

open Unit

Replaces the current candidates view with a new one.

open Unit

Controls the visibility of the candidates display area.

open Unit

open Unit

Controls the visibility of the extracted text area.

open Unit

Replaces the current input view with a new one.

Unit
setStylusHandwritingRegion(handwritingRegion: Region)

Sets a new stylus handwriting region as user continues to write on an editor on screen.

Unit

Sets the duration after which an ongoing stylus handwriting session that hasn't received new MotionEvents will time out and finishStylusHandwriting() will be called.

open Unit
setTheme(theme: Int)

You can call this to customize the theme used by your IME's window.

Boolean

Returns true if the current IME needs to offer the users ways to switch to a next input method (e.g. a globe key.).

open Unit
showStatusIcon(iconResId: Int)

open Unit
showWindow(showInput: Boolean)

open Unit

Force switch to a new input method, as identified by id.

Unit

Force switch to a new input method, as identified by id.

Boolean

Force switch to the next input method and subtype.

Boolean

Force switch to the last used input method and subtype.

open Unit

Re-evaluate whether the input method should be running in fullscreen mode, and update its UI if this has changed since the last time it was evaluated.

open Unit

Re-evaluate whether the soft input area should currently be shown, and update its UI if this has changed since the last time it was evaluated.

Protected methods
open Unit
dump(fd: FileDescriptor!, fout: PrintWriter!, args: Array<String!>!)

Performs a dump of the InputMethodService's internal state.

open Unit

Called when the subtype was changed.

Inherited functions
Unit attachBaseContext(newBase: Context!)

Application! getApplication()

Return the application that owns this service.

Int getForegroundServiceType()

If the service has become a foreground service by calling startForeground(int,android.app.Notification) or startForeground(int,android.app.Notification,int), getForegroundServiceType() returns the current foreground service type.

If there is no foregroundServiceType specified in manifest, ServiceInfo.FOREGROUND_SERVICE_TYPE_NONE is returned.

If the service is not a foreground service, ServiceInfo.FOREGROUND_SERVICE_TYPE_NONE is returned.

Unit onCreate()

Called by the system when the service is first created. Do not call this method directly.

Unit onRebind(intent: Intent!)

Called when new clients have connected to the service, after it had previously been notified that all had disconnected in its onUnbind. This will only be called if the implementation of onUnbind was overridden to return true.

Unit onStart(intent: Intent!, startId: Int)

Int onStartCommand(intent: Intent!, flags: Int, startId: Int)

Called by the system every time a client explicitly starts the service by calling android.content.Context#startService, providing the arguments it supplied and a unique integer token representing the start request. Do not call this method directly.

For backwards compatibility, the default implementation calls onStart and returns either START_STICKY or START_STICKY_COMPATIBILITY.

Note that the system calls this on your service's main thread. A service's main thread is the same thread where UI operations take place for Activities running in the same process. You should always avoid stalling the main thread's event loop. When doing long-running operations, network calls, or heavy disk I/O, you should kick off a new thread, or use android.os.AsyncTask.

Unit onTaskRemoved(rootIntent: Intent!)

This is called if the service is currently running and the user has removed a task that comes from the service's application. If you have set ServiceInfo.FLAG_STOP_WITH_TASK then you will not receive this callback; instead, the service will simply be stopped.

Unit onTimeout(startId: Int)

Callback called on timeout for ServiceInfo.FOREGROUND_SERVICE_TYPE_SHORT_SERVICE. See ServiceInfo.FOREGROUND_SERVICE_TYPE_SHORT_SERVICE for more details.

If the foreground service of type ServiceInfo.FOREGROUND_SERVICE_TYPE_SHORT_SERVICE doesn't finish even after it's timed out, the app will be declared an ANR after a short grace period of several seconds.

Starting from Android version android.os.Build.VERSION_CODES#VANILLA_ICE_CREAM, onTimeout(int,int) will also be called when a foreground service of type ServiceInfo.FOREGROUND_SERVICE_TYPE_SHORT_SERVICE times out. Developers do not need to implement both of the callbacks on android.os.Build.VERSION_CODES#VANILLA_ICE_CREAM and onwards.

Note, even though ServiceInfo.FOREGROUND_SERVICE_TYPE_SHORT_SERVICE was added on Android version android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE, it can be also used on on prior android versions (just like other new foreground service types can be used). However, because android.app.Service#onTimeout(int) did not exist on prior versions, it will never called on such versions. Because of this, developers must make sure to stop the foreground service even if android.app.Service#onTimeout(int) is not called on such versions.

Unit onTimeout(startId: Int, fgsType: Int)

Callback called when a particular foreground service type has timed out.

This callback is meant to give the app a small grace period of a few seconds to finish the foreground service of the associated type - if it fails to do so, the app will crash.

The foreground service of the associated type can be stopped within the time limit by android.app.Service#stopSelf(), android.content.Context#stopService(android.content.Intent) or their overloads. android.app.Service#stopForeground(int) can be used as well, which demotes the service to a "background" service, which will soon be stopped by the system.

The specific time limit for each type (if one exists) is mentioned in the documentation for that foreground service type. See dataSync for example.

Note: time limits are restricted to a rolling 24-hour window - for example, if a foreground service type has a time limit of 6 hours, that time counter begins as soon as the foreground service starts. This time limit will only be reset once every 24 hours or if the app comes into the foreground state.

Boolean onUnbind(intent: Intent!)

Called when all clients have disconnected from a particular interface published by the service. The default implementation does nothing and returns false.

Unit startForeground(id: Int, notification: Notification!)

If your service is started (running through Context.startService(Intent)), then also make this service run in the foreground, supplying the ongoing notification to be shown to the user while in this state. By default started services are background, meaning that their process won't be given foreground CPU scheduling (unless something else in that process is foreground) and, if the system needs to kill them to reclaim more memory (such as to display a large page in a web browser), they can be killed without too much harm. You use #startForeground if killing your service would be disruptive to the user, such as if your service is performing background music playback, so the user would notice if their music stopped playing.

Note that calling this method does not put the service in the started state itself, even though the name sounds like it. You must always call startService(android.content.Intent) first to tell the system it should keep the service running, and then use this method to tell it to keep it running harder.

Apps targeting API android.os.Build.VERSION_CODES#P or later must request the permission android.Manifest.permission#FOREGROUND_SERVICE in order to use this API.

Apps built with SDK version android.os.Build.VERSION_CODES#Q or later can specify the foreground service types using attribute android.R.attr#foregroundServiceType in service element of manifest file. The value of attribute android.R.attr#foregroundServiceType can be multiple flags ORed together.

Note: Beginning with SDK Version android.os.Build.VERSION_CODES#S, apps targeting SDK Version android.os.Build.VERSION_CODES#S or higher are not allowed to start foreground services from the background. See Behavior changes: Apps targeting Android 12 for more details.

Note: Beginning with SDK Version android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE, apps targeting SDK Version android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE or higher are not allowed to start foreground services without specifying a valid foreground service type in the manifest attribute android.R.attr#foregroundServiceType. See Behavior changes: Apps targeting Android 14 for more details.

Unit startForeground(id: Int, notification: Notification, foregroundServiceType: Int)

An overloaded version of startForeground(int,android.app.Notification) with additional foregroundServiceType parameter.

Apps built with SDK version android.os.Build.VERSION_CODES#Q or later can specify the foreground service types using attribute android.R.attr#foregroundServiceType in service element of manifest file. The value of attribute android.R.attr#foregroundServiceType can be multiple flags ORed together.

The foregroundServiceType parameter must be a subset flags of what is specified in manifest attribute android.R.attr#foregroundServiceType, if not, an IllegalArgumentException is thrown. Specify foregroundServiceType parameter as android.content.pm.ServiceInfo#FOREGROUND_SERVICE_TYPE_MANIFEST to use all flags that is specified in manifest attribute foregroundServiceType.

Note: Beginning with SDK Version android.os.Build.VERSION_CODES#S, apps targeting SDK Version android.os.Build.VERSION_CODES#S or higher are not allowed to start foreground services from the background. See Behavior changes: Apps targeting Android 12 for more details.

Note: Beginning with SDK Version android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE, apps targeting SDK Version android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE or higher are not allowed to start foreground services without specifying a valid foreground service type in the manifest attribute android.R.attr#foregroundServiceType, and the parameter foregroundServiceType here must not be the ServiceInfo.FOREGROUND_SERVICE_TYPE_NONE. See Behavior changes: Apps targeting Android 14 for more details.

Unit stopForeground(removeNotification: Boolean)

Legacy version of stopForeground(int).

Unit stopForeground(notificationBehavior: Int)

Remove this service from foreground state, allowing it to be killed if more memory is needed. This does not stop the service from running (for that you use stopSelf() or related methods), just takes it out of the foreground state.

If STOP_FOREGROUND_REMOVE is supplied, the service's associated notification will be cancelled immediately.

If STOP_FOREGROUND_DETACH is supplied, the service's association with the notification will be severed. If the notification had not yet been shown, due to foreground-service notification deferral policy, it is immediately posted when stopForeground(STOP_FOREGROUND_DETACH) is called. In all cases, the notification remains shown even after this service is stopped fully and destroyed.

If zero is passed as the argument, the result will be the legacy behavior as defined prior to Android L: the notification will remain posted until the service is fully stopped, at which time it will automatically be cancelled.

Unit stopSelf()

Stop the service, if it was previously started. This is the same as calling android.content.Context#stopService for this particular service.

Unit stopSelf(startId: Int)

Old version of stopSelfResult that doesn't return a result.

Boolean stopSelfResult(startId: Int)

Stop the service if the most recent time it was started was startId. This is the same as calling android.content.Context#stopService for this particular service but allows you to safely avoid stopping if there is a start request from a client that you haven't yet seen in onStart.

Be careful about ordering of your calls to this function.. If you call this function with the most-recently received ID before you have called it for previously received IDs, the service will be immediately stopped anyway. If you may end up processing IDs out of order (such as by dispatching them on separate threads), then you are responsible for stopping them in the same order you received them.

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

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

See bindService(android.content.Intent,int,java.util.concurrent.Executor,android.content.ServiceConnection) Call BindServiceFlags.of(long) to obtain a BindServiceFlags object.

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

See bindService(android.content.Intent,android.content.ServiceConnection,int) Call BindServiceFlags.of(long) to obtain a BindServiceFlags object.

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

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

Int checkCallingOrSelfPermission(permission: String)

Int checkCallingOrSelfUriPermission(uri: Uri!, modeFlags: Int)

IntArray checkCallingOrSelfUriPermissions(uris: MutableList<Uri!>, modeFlags: Int)

Determine whether the calling process of an IPC or you has been granted permission to access a list of URIs. This is the same as checkCallingUriPermission, except it grants your own permissions if you are not currently processing an IPC. Use with care!

Int checkCallingPermission(permission: String)

Int checkCallingUriPermission(uri: Uri!, modeFlags: Int)

IntArray checkCallingUriPermissions(uris: MutableList<Uri!>, modeFlags: Int)

Determine whether the calling process and uid has been granted permission to access a list of URIs. This is basically the same as calling checkUriPermissions(java.util.List,int,int,int) with the pid and uid returned by android.os.Binder#getCallingPid and android.os.Binder#getCallingUid. One important difference is that if you are not currently processing an IPC, this function will always fail.

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

Determine whether a particular process and uid has been granted permission to access a specific content URI.

Unlike checkUriPermission(android.net.Uri,int,int,int), this method checks for general access to the URI's content provider, as well as explicitly granted permissions.

Note, this check will throw an IllegalArgumentException for non-content URIs.

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

Int checkSelfPermission(permission: String)

Int checkUriPermission(uri: Uri!, pid: Int, uid: Int, modeFlags: Int)

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

Check both a Uri and normal permission. This allows you to perform both checkPermission and #checkUriPermission in one call.

IntArray checkUriPermissions(uris: MutableList<Uri!>, pid: Int, uid: Int, modeFlags: Int)

Determine whether a particular process and uid has been granted permission to access a list of URIs. This only checks for permissions that have been explicitly granted -- if the given process/uid has more general access to the URI's content provider then this check will always fail. Note: On SDK Version android.os.Build.VERSION_CODES#S, calling this method from a secondary-user's context will incorrectly return PackageManager.PERMISSION_DENIED for all {code uris}.

Unit clearWallpaper()

Context createAttributionContext(attributionTag: String?)

Return a new Context object for the current Context but attribute to a different tag. In complex apps attribution tagging can be used to distinguish between separate logical parts.

Context! createConfigurationContext(overrideConfiguration: Configuration)

Context createContext(contextParams: ContextParams)

Creates a context with specific properties and behaviors.

Context createDeviceContext(deviceId: Int)

Returns a new Context object from the current context but with device association given by the deviceId. Each call to this method returns a new instance of a context object. Context objects are not shared; however, common state (such as the ClassLoader and other resources for the same configuration) can be shared, so the Context itself is lightweight.

Applications that run on virtual devices may use this method to access the default device capabilities and functionality (by passing Context.DEVICE_ID_DEFAULT. Similarly, applications running on the default device may access the functionality of virtual devices.

Note that the newly created instance will be associated with the same display as the parent Context, regardless of the device ID passed here.

Context! createDeviceProtectedStorageContext()

Context! createDisplayContext(display: Display)

Context! createPackageContext(packageName: String!, flags: Int)

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

Creates a Context for a non-activity window on the given Display.

Similar to createWindowContext(int,android.os.Bundle), but the display is passed in, instead of implicitly using the original Context's Display.

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

Creates a Context for a non-activity window.

A window context is a context that can be used to add non-activity windows, such as android.view.WindowManager.LayoutParams#TYPE_APPLICATION_OVERLAY. A window context must be created from a context that has an associated Display, such as Activity or a context created with createDisplayContext(android.view.Display).

The window context is created with the appropriate Configuration for the area of the display that the windows created with it can occupy; it must be used when inflating views, such that they can be inflated with proper Resources. Below is a sample code to add an application overlay window on the primary display:

...
  final DisplayManager dm = anyContext.getSystemService(DisplayManager.class);
  final Display primaryDisplay = dm.getDisplay(DEFAULT_DISPLAY);
  final Context windowContext = anyContext.createDisplayContext(primaryDisplay)
          .createWindowContext(TYPE_APPLICATION_OVERLAY, null);
  final View overlayView = Inflater.from(windowContext).inflate(someLayoutXml, null);
 
  // WindowManager.LayoutParams initialization
  ...
  // The types used in addView and createWindowContext must match.
  mParams.type = TYPE_APPLICATION_OVERLAY;
  ...
 
  windowContext.getSystemService(WindowManager.class).addView(overlayView, mParams);
  

This context's configuration and resources are adjusted to an area of the display where the windows with provided type will be added. Note that all windows associated with the same context will have an affinity and can only be moved together between different displays or areas on a display. If there is a need to add different window types, or non-associated windows, separate Contexts should be used.

Creating a window context is an expensive operation. Misuse of this API may lead to a huge performance drop. The best practice is to use the same window context when possible. An approach is to create one window context with specific window type and display and use it everywhere it's needed.

After Build.VERSION_CODES.S, window context provides the capability to receive configuration changes for existing token by overriding the token of the android.view.WindowManager.LayoutParams passed in WindowManager.addView(View, LayoutParams). This is useful when an application needs to attach its window to an existing activity for window token sharing use-case.

Note that the window context in Build.VERSION_CODES.R didn't have this capability. This is a no-op for the window context in Build.VERSION_CODES.R.

Below is sample code to attach an existing token to a window context:
final DisplayManager dm = anyContext.getSystemService(DisplayManager.class);
  final Display primaryDisplay = dm.getDisplay(DEFAULT_DISPLAY);
  final Context windowContext = anyContext.createWindowContext(primaryDisplay,
          TYPE_APPLICATION, null);
 
  // Get an existing token.
  final IBinder existingToken = activity.getWindow().getAttributes().token;
 
  // The types used in addView() and createWindowContext() must match.
  final WindowManager.LayoutParams params = new WindowManager.LayoutParams(TYPE_APPLICATION);
  params.token = existingToken;
 
  // After WindowManager#addView(), the server side will extract the provided token from
  // LayoutParams#token (existingToken in the sample code), and switch to propagate
  // configuration changes from the node associated with the provided token.
  windowContext.getSystemService(WindowManager.class).addView(overlayView, mParams);
  

After Build.VERSION_CODES.S, window context provides the capability to listen to its Configuration changes by calling registerComponentCallbacks(android.content.ComponentCallbacks), while other kinds of Context will register the ComponentCallbacks to its. Note that window context only propagate ComponentCallbacks.onConfigurationChanged(Configuration) callback. ComponentCallbacks.onLowMemory() or other callbacks in ComponentCallbacks2 won't be invoked.

Note that using android.app.Application or android.app.Service context for UI-related queries may result in layout or continuity issues on devices with variable screen sizes (e.g. foldables) or in multi-window modes, since these non-UI contexts may not reflect the Configuration changes for the visual container.

Array<String!>! databaseList()

Boolean deleteDatabase(name: String!)

Boolean deleteFile(name: String!)

Boolean deleteSharedPreferences(name: String!)

Unit enforceCallingOrSelfPermission(permission: String, message: String?)

If neither you nor the calling process of an IPC you are handling has been granted a particular permission, throw a SecurityException. This is the same as enforceCallingPermission, except it grants your own permissions if you are not currently processing an IPC. Use with care!

Unit enforceCallingOrSelfUriPermission(uri: Uri!, modeFlags: Int, message: String!)

Unit enforceCallingPermission(permission: String, message: String?)

If the calling process of an IPC you are handling has not been granted a particular permission, throw a SecurityException. This is basically the same as calling enforcePermission(java.lang.String,int,int,java.lang.String) with the pid and uid returned by android.os.Binder#getCallingPid and android.os.Binder#getCallingUid. One important difference is that if you are not currently processing an IPC, this function will always throw the SecurityException. This is done to protect against accidentally leaking permissions; you can use enforceCallingOrSelfPermission to avoid this protection.

Unit enforceCallingUriPermission(uri: Uri!, modeFlags: Int, message: String!)

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

If the given permission is not allowed for a particular process and user ID running in the system, throw a SecurityException.

Unit enforceUriPermission(uri: Uri!, pid: Int, uid: Int, modeFlags: Int, message: String!)

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

Enforce both a Uri and normal permission. This allows you to perform both enforcePermission and #enforceUriPermission in one call.

Array<String!>! fileList()

Context! getApplicationContext()

ApplicationInfo! getApplicationInfo()

AssetManager! getAssets()

AttributionSource getAttributionSource()

Context! getBaseContext()

File! getCacheDir()

ClassLoader! getClassLoader()

File! getCodeCacheDir()

ContentResolver! getContentResolver()

File! getDataDir()

File! getDatabasePath(name: String!)

Int getDeviceId()

File! getDir(name: String!, mode: Int)

Display! getDisplay()

Get the display this context is associated with. Applications should use this method with android.app.Activity or a context associated with a Display via createDisplayContext(android.view.Display) to get a display object associated with a Context, or android.hardware.display.DisplayManager#getDisplay to get a display object by id.

File? getExternalCacheDir()

Returns absolute path to application-specific directory on the primary shared/external storage device where the application can place cache files it owns. These files are internal to the application, and not typically visible to the user as media.

This is like getCacheDir() in that these files will be deleted when the application is uninstalled, however there are some important differences:

If a shared storage device is emulated (as determined by Environment.isExternalStorageEmulated(File)), its contents are backed by a private user data partition, which means there is little benefit to storing data here instead of the private directory returned by getCacheDir().

Starting in android.os.Build.VERSION_CODES#KITKAT, no permissions are required to read or write to the returned path; it's always accessible to the calling app. This only applies to paths generated for package name of the calling application. To access paths belonging to other packages, android.Manifest.permission#WRITE_EXTERNAL_STORAGE and/or android.Manifest.permission#READ_EXTERNAL_STORAGE are required.

On devices with multiple users (as described by UserManager), each user has their own isolated shared storage. Applications only have access to the shared storage for the user they're running as.

The returned path may change over time if different shared storage media is inserted, so only relative paths should be persisted.

Array<File!>! getExternalCacheDirs()

File? getExternalFilesDir(type: String?)

Returns the absolute path to the directory on the primary shared/external storage device where the application can place persistent files it owns. These files are internal to the applications, and not typically visible to the user as media.

This is like getFilesDir() in that these files will be deleted when the application is uninstalled, however there are some important differences:

If a shared storage device is emulated (as determined by Environment.isExternalStorageEmulated(File)), its contents are backed by a private user data partition, which means there is little benefit to storing data here instead of the private directories returned by getFilesDir(), etc.

Starting in android.os.Build.VERSION_CODES#KITKAT, no permissions are required to read or write to the returned path; it's always accessible to the calling app. This only applies to paths generated for package name of the calling application. To access paths belonging to other packages, android.Manifest.permission#WRITE_EXTERNAL_STORAGE and/or android.Manifest.permission#READ_EXTERNAL_STORAGE are required.

On devices with multiple users (as described by UserManager), each user has their own isolated shared storage. Applications only have access to the shared storage for the user they're running as.

The returned path may change over time if different shared storage media is inserted, so only relative paths should be persisted.

Here is an example of typical code to manipulate a file in an application's shared storage:

If you supply a non-null type to this function, the returned file will be a path to a sub-directory of the given type. Though these files are not automatically scanned by the media scanner, you can explicitly add them to the media database with MediaScannerConnection.scanFile. Note that this is not the same as Environment.getExternalStoragePublicDirectory(), which provides directories of media shared by all applications. The directories returned here are owned by the application, and their contents will be removed when the application is uninstalled. Unlike Environment.getExternalStoragePublicDirectory(), the directory returned here will be automatically created for you.

Here is an example of typical code to manipulate a picture in an application's shared storage and add it to the media database:

Array<File!>! getExternalFilesDirs(type: String!)

Array<File!>! getExternalMediaDirs()

File! getFileStreamPath(name: String!)

File! getFilesDir()

Executor! getMainExecutor()

Looper! getMainLooper()

File! getNoBackupFilesDir()

File! getObbDir()

Array<File!>! getObbDirs()

String! getPackageCodePath()

PackageManager! getPackageManager()

String! getPackageName()

String! getPackageResourcePath()

ContextParams? getParams()

Return the set of parameters which this Context was created with, if it was created via createContext(android.content.ContextParams).

Resources! getResources()

SharedPreferences! getSharedPreferences(name: String!, mode: Int)

Any! getSystemService(name: String)

String? getSystemServiceName(serviceClass: Class<*>)

Resources.Theme! getTheme()

Drawable! getWallpaper()

Int getWallpaperDesiredMinimumHeight()

Int getWallpaperDesiredMinimumWidth()

Unit grantUriPermission(toPackage: String!, uri: Uri!, modeFlags: Int)

Boolean isDeviceProtectedStorage()

Boolean isRestricted()

Boolean moveDatabaseFrom(sourceContext: Context!, name: String!)

Boolean moveSharedPreferencesFrom(sourceContext: Context!, name: String!)

FileInputStream! openFileInput(name: String!)

FileOutputStream! openFileOutput(name: String!, mode: Int)

SQLiteDatabase! openOrCreateDatabase(name: String!, mode: Int, factory: SQLiteDatabase.CursorFactory!)

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

Open a new private SQLiteDatabase associated with this Context's application package. Creates the database file if it doesn't exist.

Accepts input param: a concrete instance of DatabaseErrorHandler to be used to handle corruption when sqlite reports database corruption.

Drawable! peekWallpaper()

Unit registerComponentCallbacks(callback: ComponentCallbacks!)

Add a new ComponentCallbacks to the base application of the Context, which will be called at the same times as the ComponentCallbacks methods of activities and other components are called. Note that you must be sure to use unregisterComponentCallbacks when appropriate in the future; this will not be removed for you.

After Build.VERSION_CODES.TIRAMISU, the ComponentCallbacks will be registered to the base Context, and can be only used after attachBaseContext(android.content.Context). Users can still call to getApplicationContext().registerComponentCallbacks(ComponentCallbacks) to add ComponentCallbacks to the base application.

Unit registerDeviceIdChangeListener(executor: Executor, listener: IntConsumer)

Adds a new device ID changed listener to the Context, which will be called when the device association is changed by the system.

The callback can be called when an app is moved to a different device and the Context is not explicitly associated with a specific device.

When an application receives a device id update callback, this Context is guaranteed to also have an updated display ID(if any) and Configuration.

Intent? registerReceiver(receiver: BroadcastReceiver?, filter: IntentFilter!)

Register a BroadcastReceiver to be run in the main activity thread. The receiver will be called with any broadcast Intent that matches filter, in the main application thread.

The system may broadcast Intents that are "sticky" -- these stay around after the broadcast has finished, to be sent to any later registrations. If your IntentFilter matches one of these sticky Intents, that Intent will be returned by this function and sent to your receiver as if it had just been broadcast.

There may be multiple sticky Intents that match filter, in which case each of these will be sent to receiver. In this case, only one of these can be returned directly by the function; which of these that is returned is arbitrarily decided by the system.

If you know the Intent your are registering for is sticky, you can supply null for your receiver. In this case, no receiver is registered -- the function simply returns the sticky Intent that matches filter. In the case of multiple matches, the same rules as described above apply.

See BroadcastReceiver for more information on Intent broadcasts.

As of android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE, the system can place context-registered broadcasts in a queue while the app is in the cached state. When the app leaves the cached state, such as returning to the foreground, the system delivers any queued broadcasts. Multiple instances of certain broadcasts might be merged into one broadcast.

As of android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH, receivers registered with this method will correctly respect the Intent.setPackage(String) specified for an Intent being broadcast. Prior to that, it would be ignored and delivered to all matching registered receivers. Be careful if using this for security.

For apps targeting android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE, either RECEIVER_EXPORTED or RECEIVER_NOT_EXPORTED must be specified if the receiver is not being registered for system broadcasts or a SecurityException will be thrown. See registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter,int) to register a receiver with flags.

Note: this method cannot be called from a BroadcastReceiver component; that is, from a BroadcastReceiver that is declared in an application's manifest. It is okay, however, to call this method from another BroadcastReceiver that has itself been registered at run time with #registerReceiver, since the lifetime of such a registered BroadcastReceiver is tied to the object that registered it.

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

Register to receive intent broadcasts, with the receiver optionally being exposed to Instant Apps. See registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter) for more information. By default Instant Apps cannot interact with receivers in other applications, this allows you to expose a receiver that Instant Apps can interact with.

See BroadcastReceiver for more information on Intent broadcasts.

As of android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE, the system can place context-registered broadcasts in a queue while the app is in the cached state. When the app leaves the cached state, such as returning to the foreground, the system delivers any queued broadcasts. Multiple instances of certain broadcasts might be merged into one broadcast.

As of android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH, receivers registered with this method will correctly respect the Intent.setPackage(String) specified for an Intent being broadcast. Prior to that, it would be ignored and delivered to all matching registered receivers. Be careful if using this for security.

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

Register to receive intent broadcasts, to run in the context of scheduler. See registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter) for more information. This allows you to enforce permissions on who can broadcast intents to your receiver, or have the receiver run in a different thread than the main application thread.

See BroadcastReceiver for more information on Intent broadcasts.

As of android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE, the system can place context-registered broadcasts in a queue while the app is in the cached state. When the app leaves the cached state, such as returning to the foreground, the system delivers any queued broadcasts. Multiple instances of certain broadcasts might be merged into one broadcast.

As of android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH, receivers registered with this method will correctly respect the Intent.setPackage(String) specified for an Intent being broadcast. Prior to that, it would be ignored and delivered to all matching registered receivers. Be careful if using this for security.

For apps targeting android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE, either RECEIVER_EXPORTED or RECEIVER_NOT_EXPORTED must be specified if the receiver is not being registered for system broadcasts or a SecurityException will be thrown. See registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter,java.lang.String,android.os.Handler,int) to register a receiver with flags.

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

Register to receive intent broadcasts, to run in the context of scheduler. See registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter,int) and registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter,java.lang.String,android.os.Handler) for more information.

See BroadcastReceiver for more information on Intent broadcasts.

As of android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE, the system can place context-registered broadcasts in a queue while the app is in the cached state. When the app leaves the cached state, such as returning to the foreground, the system delivers any queued broadcasts. Multiple instances of certain broadcasts might be merged into one broadcast.

As of android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH, receivers registered with this method will correctly respect the Intent.setPackage(String) specified for an Intent being broadcast. Prior to that, it would be ignored and delivered to all matching registered receivers. Be careful if using this for security.

Unit removeStickyBroadcast(intent: Intent!)

Unit removeStickyBroadcastAsUser(intent: Intent!, user: UserHandle!)

Unit revokeSelfPermissionsOnKill(permissions: MutableCollection<String!>)

Triggers the revocation of one or more permissions for the calling package. A package is only able to revoke runtime permissions. If a permission is not currently granted, it is ignored and will not get revoked (even if later granted by the user). Ultimately, you should never make assumptions about a permission status as users may grant or revoke them at any time.

Background permissions which have no corresponding foreground permission still granted once the revocation is effective will also be revoked.

The revocation happens asynchronously and kills all processes running in the calling UID. It will be triggered once it is safe to do so. In particular, it will not be triggered as long as the package remains in the foreground, or has any active manifest components (e.g. when another app is accessing a content provider in the package).

If you want to revoke the permissions right away, you could call System.exit() in Handler.postDelayed with a delay to allow completion of async IPC, But System.exit() could affect other apps that are accessing your app at the moment. For example, apps accessing a content provider in your app will all crash.

Note that the settings UI shows a permission group as granted as long as at least one permission in the group is granted. If you want the user to observe the revocation in the settings, you should revoke every permission in the target group. To learn the current list of permissions in a group, you may use PackageManager.getGroupOfPlatformPermission(String, Executor, Consumer) and PackageManager.getPlatformPermissionsForGroup(String, Executor, Consumer). This list of permissions may evolve over time, so it is recommended to check whether it contains any permission you wish to retain before trying to revoke an entire group.

Unit revokeUriPermission(uri: Uri!, modeFlags: Int)

Unit revokeUriPermission(targetPackage: String!, uri: Uri!, modeFlags: Int)

Unit sendBroadcast(intent: Intent!)

Unit sendBroadcast(intent: Intent!, receiverPermission: String?)

Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run. No results are propagated from receivers and receivers can not abort the broadcast. If you want to allow receivers to propagate results or abort the broadcast, you must send an ordered broadcast using sendOrderedBroadcast(android.content.Intent,java.lang.String).

See BroadcastReceiver for more information on Intent broadcasts.

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

Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run. No results are propagated from receivers and receivers can not abort the broadcast. If you want to allow receivers to propagate results or abort the broadcast, you must send an ordered broadcast using sendOrderedBroadcast(android.content.Intent,java.lang.String).

See BroadcastReceiver for more information on Intent broadcasts.

Unit sendBroadcastAsUser(intent: Intent!, user: UserHandle!)

Unit sendBroadcastAsUser(intent: Intent!, user: UserHandle!, receiverPermission: String?)

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

Unit sendOrderedBroadcast(intent: Intent!, receiverPermission: String?)

Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run.

See BroadcastReceiver for more information on Intent broadcasts.

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

Version of sendBroadcast(android.content.Intent) that allows you to receive data back from the broadcast. This is accomplished by supplying your own BroadcastReceiver when calling, which will be treated as a final receiver at the end of the broadcast -- its BroadcastReceiver.onReceive method will be called with the result values collected from the other receivers. The broadcast will be serialized in the same way as calling sendOrderedBroadcast(android.content.Intent,java.lang.String).

Like sendBroadcast(android.content.Intent), this method is asynchronous; it will return before resultReceiver.onReceive() is called.

See BroadcastReceiver for more information on Intent broadcasts.

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

Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run.

See BroadcastReceiver for more information on Intent broadcasts.

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

Version of sendBroadcast(android.content.Intent) that allows you to receive data back from the broadcast. This is accomplished by supplying your own BroadcastReceiver when calling, which will be treated as a final receiver at the end of the broadcast -- its BroadcastReceiver.onReceive method will be called with the result values collected from the other receivers. The broadcast will be serialized in the same way as calling sendOrderedBroadcast(android.content.Intent,java.lang.String).

Like sendBroadcast(android.content.Intent), this method is asynchronous; it will return before resultReceiver.onReceive() is called.

See BroadcastReceiver for more information on Intent broadcasts.

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

Version of sendOrderedBroadcast(android.content.Intent,java.lang.String,android.content.BroadcastReceiver,android.os.Handler,int,java.lang.String,android.os.Bundle) that allows you to specify the App Op to enforce restrictions on which receivers the broadcast will be sent to.

See BroadcastReceiver for more information on Intent broadcasts.

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

Version of sendOrderedBroadcast(android.content.Intent,java.lang.String,android.content.BroadcastReceiver,android.os.Handler,int,java.lang.String,android.os.Bundle) that allows you to specify the user the broadcast will be sent to. This is not available to applications that are not pre-installed on the system image.

See BroadcastReceiver for more information on Intent broadcasts.
Requires android.Manifest.permission.INTERACT_ACROSS_USERS

Unit sendStickyBroadcast(intent: Intent!)

Unit sendStickyBroadcast(intent: Intent, options: Bundle?)

Perform a sendBroadcast(android.content.Intent) that is "sticky," meaning the Intent you are sending stays around after the broadcast is complete, so that others can quickly retrieve that data through the return value of registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter). In all other ways, this behaves the same as sendBroadcast(android.content.Intent).

Unit sendStickyBroadcastAsUser(intent: Intent!, user: UserHandle!)

Unit sendStickyOrderedBroadcast(intent: Intent!, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)

Version of #sendStickyBroadcast that allows you to receive data back from the broadcast. This is accomplished by supplying your own BroadcastReceiver when calling, which will be treated as a final receiver at the end of the broadcast -- its BroadcastReceiver.onReceive method will be called with the result values collected from the other receivers. The broadcast will be serialized in the same way as calling sendOrderedBroadcast(android.content.Intent,java.lang.String).

Like sendBroadcast(android.content.Intent), this method is asynchronous; it will return before resultReceiver.onReceive() is called. Note that the sticky data stored is only the data you initially supply to the broadcast, not the result of any changes made by the receivers.

See BroadcastReceiver for more information on Intent broadcasts.
Requires android.Manifest.permission#BROADCAST_STICKY

Unit sendStickyOrderedBroadcastAsUser(intent: Intent!, user: UserHandle!, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)

Version of sendStickyOrderedBroadcast(android.content.Intent,android.content.BroadcastReceiver,android.os.Handler,int,java.lang.String,android.os.Bundle) that allows you to specify the user the broadcast will be sent to. This is not available to applications that are not pre-installed on the system image.

See BroadcastReceiver for more information on Intent broadcasts.
Requires android.Manifest.permission.INTERACT_ACROSS_USERS and android.Manifest.permission#BROADCAST_STICKY

Unit setTheme(resid: Int)

Unit setWallpaper(bitmap: Bitmap!)

Unit setWallpaper(data: InputStream!)

Unit startActivities(intents: Array<Intent!>!)

Unit startActivities(intents: Array<Intent!>!, options: Bundle?)

Launch multiple new activities. This is generally the same as calling startActivity(android.content.Intent) for the first Intent in the array, that activity during its creation calling startActivity(android.content.Intent) for the second entry, etc. Note that unlike that approach, generally none of the activities except the last in the array will be created at this point, but rather will be created when the user first visits them (due to pressing back from the activity on top).

This method throws ActivityNotFoundException if there was no Activity found for any given Intent. In this case the state of the activity stack is undefined (some Intents in the list may be on it, some not), so you probably want to avoid such situations.

Unit startActivity(intent: Intent!)

Unit startActivity(intent: Intent!, options: Bundle?)

Launch a new activity. You will not receive any information about when the activity exits.

Note that if this method is being called from outside of an android.app.Activity Context, then the Intent must include the Intent.FLAG_ACTIVITY_NEW_TASK launch flag. This is because, without being started from an existing Activity, there is no existing task in which to place the new activity and thus it needs to be placed in its own separate task.

This method throws ActivityNotFoundException if there was no Activity found to run the given Intent.

ComponentName? startForegroundService(service: Intent!)

Similar to startService(android.content.Intent), but with an implicit promise that the Service will call startForeground(int, android.app.Notification) once it begins running. The service is given an amount of time comparable to the ANR interval to do this, otherwise the system will automatically crash the process, in which case an internal exception ForegroundServiceDidNotStartInTimeException is logged on logcat on devices running SDK Version android.os.Build.VERSION_CODES#S or later. On older Android versions, an internal exception RemoteServiceException is logged instead, with a corresponding message.

Unlike the ordinary startService(android.content.Intent), this method can be used at any time, regardless of whether the app hosting the service is in a foreground state.

Note: Beginning with SDK Version android.os.Build.VERSION_CODES#S, apps targeting SDK Version android.os.Build.VERSION_CODES#S or higher are not allowed to start foreground services from the background. See Behavior changes: Apps targeting Android 12 for more details.

Boolean startInstrumentation(className: ComponentName, profileFile: String?, arguments: Bundle?)

Start executing an android.app.Instrumentation class. The given Instrumentation component will be run by killing its target application (if currently running), starting the target process, instantiating the instrumentation component, and then letting it drive the application.

This function is not synchronous -- it returns as soon as the instrumentation has started and while it is running.

Instrumentation is normally only allowed to run against a package that is either unsigned or signed with a signature that the the instrumentation package is also signed with (ensuring the target trusts the instrumentation).

Unit startIntentSender(intent: IntentSender!, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int)

Same as startIntentSender(android.content.IntentSender,android.content.Intent,int,int,int,android.os.Bundle) with no options specified.

Unit startIntentSender(intent: IntentSender!, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: Bundle?)

Like startActivity(android.content.Intent,android.os.Bundle), but taking a IntentSender to start. If the IntentSender is for an activity, that activity will be started as if you had called the regular startActivity(android.content.Intent) here; otherwise, its associated action will be executed (such as sending a broadcast) as if you had called android.content.IntentSender#sendIntent on it.

ComponentName? startService(service: Intent!)

Request that a given application service be started. The Intent should either contain the complete class name of a specific service implementation to start, or a specific package name to target. If the Intent is less specified, it logs a warning about this. In this case any of the multiple matching services may be used. If this service is not already running, it will be instantiated and started (creating a process for it if needed); if it is running then it remains running.

Every call to this method will result in a corresponding call to the target service's android.app.Service#onStartCommand method, with the intent given here. This provides a convenient way to submit jobs to a service without having to bind and call on to its interface.

Using startService() overrides the default service lifetime that is managed by #bindService: it requires the service to remain running until stopService is called, regardless of whether any clients are connected to it. Note that calls to startService() do not nest: no matter how many times you call startService(), a single call to stopService will stop it.

The system attempts to keep running services around as much as possible. The only time they should be stopped is if the current foreground application is using so many resources that the service needs to be killed. If any errors happen in the service's process, it will automatically be restarted.

This function will throw SecurityException if you do not have permission to start the given service.

Note: Each call to startService() results in significant work done by the system to manage service lifecycle surrounding the processing of the intent, which can take multiple milliseconds of CPU time. Due to this cost, startService() should not be used for frequent intent delivery to a service, and only for scheduling significant work. Use #bindService for high frequency calls.

Beginning with SDK Version android.os.Build.VERSION_CODES#O, apps targeting SDK Version android.os.Build.VERSION_CODES#O or higher are not allowed to start background services from the background. See Background Execution Limits for more details.

Note: Beginning with SDK Version android.os.Build.VERSION_CODES#S, apps targeting SDK Version android.os.Build.VERSION_CODES#S or higher are not allowed to start foreground services from the background. See Behavior changes: Apps targeting Android 12 for more details.

Boolean stopService(name: Intent!)

Unit unbindService(conn: ServiceConnection)

Unit unregisterComponentCallbacks(callback: ComponentCallbacks!)

Remove a ComponentCallbacks object that was previously registered with registerComponentCallbacks(android.content.ComponentCallbacks).

After Build.VERSION_CODES.TIRAMISU, the ComponentCallbacks will be unregistered to the base Context, and can be only used after attachBaseContext(android.content.Context)

Unit unregisterDeviceIdChangeListener(listener: IntConsumer)

Removes a device ID changed listener from the Context. It's a no-op if the listener is not already registered.

Unit unregisterReceiver(receiver: BroadcastReceiver!)

Unit updateServiceGroup(conn: ServiceConnection, group: Int, importance: Int)

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

See bindIsolatedService(android.content.Intent,int,java.lang.String,java.util.concurrent.Executor,android.content.ServiceConnection) Call BindServiceFlags.of(long) to obtain a BindServiceFlags object.

Int getColor(id: Int)

Returns a color associated with a particular resource ID and styled for the current theme.

ColorStateList getColorStateList(id: Int)

Returns a color state list associated with a particular resource ID and styled for the current theme.

Drawable? getDrawable(id: Int)

Returns a drawable object associated with a particular resource ID and styled for the current theme.

String getString(resId: Int)

Returns a localized string from the application's package's default string table.

String getString(resId: Int, vararg formatArgs: Any!)

Returns a localized formatted string from the application's package's default string table, substituting the format arguments as defined in java.util.Formatter and java.lang.String#format.

T getSystemService(serviceClass: Class<T>)

Return the handle to a system-level service by class.

Currently available classes are: android.view.WindowManager, android.view.LayoutInflater, android.app.ActivityManager, android.os.PowerManager, android.app.AlarmManager, android.app.NotificationManager, android.app.KeyguardManager, android.location.LocationManager, android.app.SearchManager, android.os.Vibrator, android.net.ConnectivityManager, android.net.wifi.WifiManager, android.media.AudioManager, android.media.MediaRouter, android.telephony.TelephonyManager, android.telephony.SubscriptionManager, android.view.inputmethod.InputMethodManager, android.app.UiModeManager, android.app.DownloadManager, android.os.BatteryManager, android.app.job.JobScheduler, android.app.usage.NetworkStatsManager, android.content.pm.verify.domain.DomainVerificationManager, android.view.displayhash.DisplayHashManager android.security.authenticationpolicy.AuthenticationPolicyManager.

Note: System services obtained via this API may be closely associated with the Context in which they are obtained from. In general, do not share the service objects between various different contexts (Activities, Applications, Services, Providers, etc.)

Note: Instant apps, for which PackageManager.isInstantApp() returns true, don't have access to the following system services: DEVICE_POLICY_SERVICE, FINGERPRINT_SERVICE, KEYGUARD_SERVICE, SHORTCUT_SERVICE, USB_SERVICE, WALLPAPER_SERVICE, WIFI_P2P_SERVICE, WIFI_SERVICE, WIFI_AWARE_SERVICE. For these services this method will return null. Generally, if you are running as an instant app you should always check whether the result of this method is null.

CharSequence getText(resId: Int)

Return a localized, styled CharSequence from the application's package's default string table.

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

Retrieve styled attribute information in this Context's theme. See android.content.res.Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int) for more information.

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

Retrieve styled attribute information in this Context's theme. See android.content.res.Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int) for more information.

TypedArray obtainStyledAttributes(resid: Int, attrs: IntArray)

Retrieve styled attribute information in this Context's theme. See android.content.res.Resources.Theme#obtainStyledAttributes(int, int[]) for more information.

TypedArray obtainStyledAttributes(attrs: IntArray)

Retrieve styled attribute information in this Context's theme. See android.content.res.Resources.Theme#obtainStyledAttributes(int[]) for more information.

Unit revokeSelfPermissionOnKill(permName: String)

Triggers the asynchronous revocation of a runtime permission. If the permission is not currently granted, nothing happens (even if later granted by the user).

Unit sendBroadcastWithMultiplePermissions(intent: Intent, receiverPermissions: Array<String!>)

Broadcast the given intent to all interested BroadcastReceivers, allowing an array of required permissions to be enforced. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run. No results are propagated from receivers and receivers can not abort the broadcast. If you want to allow receivers to propagate results or abort the broadcast, you must send an ordered broadcast using sendOrderedBroadcast(android.content.Intent,java.lang.String).

See BroadcastReceiver for more information on Intent broadcasts.

KeyEvent.DispatcherState! getKeyDispatcherState()

Return the global KeyEvent.DispatcherState for used for processing events from the target application. Normally you will not need to use this directly, but just use the standard high-level event callbacks like onKeyDown.

IBinder? onBind(intent: Intent!)

Unit onLowMemory()

Override Service's empty implementation and listen to ActivityThread for low memory and trim memory events.

Unit onTrimMemory(level: Int)

Unit registerComponentCallbacks(callback: ComponentCallbacks)

Add a new ComponentCallbacks to the base application of the Context, which will be called at the same times as the ComponentCallbacks methods of activities and other components are called. Note that you must be sure to use unregisterComponentCallbacks when appropriate in the future; this will not be removed for you.

After Build.VERSION_CODES.TIRAMISU, the ComponentCallbacks will be registered to the base Context, and can be only used after attachBaseContext(android.content.Context). Users can still call to getApplicationContext().registerComponentCallbacks(ComponentCallbacks) to add ComponentCallbacks to the base application.

Unit unregisterComponentCallbacks(callback: ComponentCallbacks)

Remove a ComponentCallbacks object that was previously registered with registerComponentCallbacks(android.content.ComponentCallbacks).

After Build.VERSION_CODES.TIRAMISU, the ComponentCallbacks will be unregistered to the base Context, and can be only used after attachBaseContext(android.content.Context)

Unit onConfigurationChanged(newConfig: Configuration)

Called by the system when the device configuration changes while your component is running. Note that, unlike activities, other components are never restarted when a configuration changes: they must always deal with the results of the change, such as by re-retrieving resources.

At the time that this function has been called, your Resources object will have been updated to return resource values matching the new configuration.

For more information, read Handling Runtime Changes.

Unit onLowMemory()

This is called when the overall system is running low on memory, and actively running processes should trim their memory usage. While the exact point at which this will be called is not defined, generally it will happen when all background process have been killed. That is, before reaching the point of killing processes hosting service and foreground UI that we would like to avoid killing.

Boolean onKeyDown(keyCode: Int, event: KeyEvent!)

Called when a key down event has occurred. If you return true, you can first call KeyEvent.startTracking() to have the framework track the event through its onKeyUp(int,android.view.KeyEvent) and also call your onKeyLongPress(int,android.view.KeyEvent) if it occurs.

Boolean onKeyLongPress(keyCode: Int, event: KeyEvent!)

Called when a long press has occurred. If you return true, the final key up will have KeyEvent.FLAG_CANCELED and KeyEvent.FLAG_CANCELED_LONG_PRESS set. Note that in order to receive this callback, someone in the event change must return true from onKeyDown and call KeyEvent.startTracking() on the event.

Boolean onKeyMultiple(keyCode: Int, count: Int, event: KeyEvent!)

Called when a user's interaction with an analog control, such as flinging a trackball, generates simulated down/up events for the same key multiple times in quick succession.

Boolean onKeyUp(keyCode: Int, event: KeyEvent!)

Called when a key up event has occurred.

XML attributes

android:imeExtractEnterAnimation

android:imeExtractEnterAnimation
Animation to use when showing the fullscreen extract UI after it had previously been hidden.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:imeExtractExitAnimation

android:imeExtractExitAnimation
Animation to use when hiding the fullscreen extract UI after it had previously been shown.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:imeFullscreenBackground

android:imeFullscreenBackground
Background to use for entire input method when it is being shown in fullscreen mode with the extract view, to ensure that it completely covers the application. This allows, for example, the candidate view to be hidden while in fullscreen mode without having the application show through behind it.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

May be a color value, in the form of "rgb", "argb", "rrggbb", or "aarrggbb".

Constants

BACK_DISPOSITION_ADJUST_NOTHING

Added in API level 28
static val BACK_DISPOSITION_ADJUST_NOTHING: Int

Asks the system to not adjust the back button affordance even when the software keyboard is shown.

This mode is useful for UI modes where IME's main soft input window is used for some supplemental UI, such as floating candidate window for languages such as Chinese and Japanese, where users expect the back button is, or at least looks to be, handled by the target application rather than the UI shown by the IME even while isInputViewShown() returns true.

Note that KeyEvent.KEYCODE_BACK events continue to be sent to onKeyDown(int,android.view.KeyEvent) even when this mode is specified. The default implementation of onKeyDown(int,android.view.KeyEvent) for KeyEvent.KEYCODE_BACK does not take this mode into account.

Value: 3

BACK_DISPOSITION_DEFAULT

Added in API level 11
static val BACK_DISPOSITION_DEFAULT: Int

Allows the system to optimize the back button affordance based on the presence of software keyboard.

For instance, on devices that have navigation bar and software-rendered back button, the system may use a different icon while isInputViewShown() returns true, to indicate that the back button has "dismiss" affordance.

Note that KeyEvent.KEYCODE_BACK events continue to be sent to onKeyDown(int,android.view.KeyEvent) even when this mode is specified. The default implementation of onKeyDown(int,android.view.KeyEvent) for KeyEvent.KEYCODE_BACK does not take this mode into account.

For API level android.os.Build.VERSION_CODES#O_MR1 and lower devices, this is the only mode you can safely specify without worrying about the compatibility.

Value: 0

BACK_DISPOSITION_WILL_DISMISS

Added in API level 11
Deprecated in API level 28
static val BACK_DISPOSITION_WILL_DISMISS: Int

Deprecated: on android.os.Build.VERSION_CODES#P and later devices, this flag is handled as a synonym of BACK_DISPOSITION_DEFAULT. On android.os.Build.VERSION_CODES#O_MR1 and prior devices, expected behavior of this mode had not been well defined. In AOSP implementation running on devices that have navigation bar, specifying this flag could change the software back button to "Dismiss" icon no matter whether the software keyboard is shown or not, but there would be no easy way to restore the icon state even after IME lost the connection to the application. To avoid user confusions, do not specify this mode anyway

Deprecated flag.

To avoid compatibility issues, IME developers should not use this flag.

Value: 2

BACK_DISPOSITION_WILL_NOT_DISMISS

Added in API level 11
Deprecated in API level 28
static val BACK_DISPOSITION_WILL_NOT_DISMISS: Int

Deprecated: on android.os.Build.VERSION_CODES#P and later devices, this flag is handled as a synonym of BACK_DISPOSITION_DEFAULT. On android.os.Build.VERSION_CODES#O_MR1 and prior devices, expected behavior of this mode had not been well defined. Most likely the end result would be the same as BACK_DISPOSITION_DEFAULT. Either way it is not recommended to use this mode

Deprecated flag.

To avoid compatibility issues, IME developers should not use this flag.

Value: 1

Public constructors

InputMethodService

InputMethodService()

Public methods

enableHardwareAcceleration

Added in API level 17
Deprecated in API level 21
open fun enableHardwareAcceleration(): Boolean

Deprecated: Starting in API 21, hardware acceleration is always enabled on capable devices

You can call this to try to enable accelerated drawing for your IME. This must be set before onCreate(), so you will typically call it in your constructor. It is not always possible to use hardware accelerated drawing in an IME (for example on low-end devices that do not have the resources to support this), so the call true if it succeeds otherwise false if you will need to draw in software. You must be able to handle either case.

In API 21 and later, system may automatically enable hardware accelerated drawing for your IME on capable devices even if this method is not explicitly called. Make sure that your IME is able to handle either case.

Return
Boolean true if accelerated drawing is successfully enabled otherwise false. On API 21 and later devices the return value is basically just a hint and your IME does not need to change the behavior based on the it

finishConnectionlessStylusHandwriting

Added in API level 35
fun finishConnectionlessStylusHandwriting(text: CharSequence?): Unit

Finishes the current connectionless stylus handwriting session and delivers the result.

This dismisses the ink window and stops intercepting stylus MotionEvents.

Note for IME developers: Call this method at any time to finish the current handwriting session. Generally, this should be invoked after a short timeout, giving the user enough time to start the next stylus stroke, if any. By default, system will time-out after few seconds. To override default timeout, use setStylusHandwritingSessionTimeout(java.time.Duration).

Parameters
text CharSequence?: This value may be null.

finishStylusHandwriting

Added in API level 33
fun finishStylusHandwriting(): Unit

Finish the current stylus handwriting session.

This dismisses the ink window and stops intercepting stylus MotionEvents.

Connectionless handwriting sessions should be finished using finishConnectionlessStylusHandwriting(java.lang.CharSequence).

Note for IME developers: Call this method at any time to finish the current handwriting session. Generally, this should be invoked after a short timeout, giving the user enough time to start the next stylus stroke, if any. By default, system will time-out after few seconds. To override default timeout, use setStylusHandwritingSessionTimeout(java.time.Duration).

Handwriting session will be finished by framework on next onFinishInput().

getCandidatesHiddenVisibility

Added in API level 3
open fun getCandidatesHiddenVisibility(): Int

Returns the visibility mode (either View.INVISIBLE or View.GONE) of the candidates view when it is not shown. The default implementation returns GONE when isExtractViewShown returns true, otherwise INVISIBLE. Be careful if you change this to return GONE in other situations -- if showing or hiding the candidates view causes your window to resize, this can cause temporary drawing artifacts as the resize takes place.

getCurrentInputBinding

Added in API level 3
open fun getCurrentInputBinding(): InputBinding!

Return the currently active InputBinding for the input method, or null if there is none.

getCurrentInputConnection

Added in API level 3
open fun getCurrentInputConnection(): InputConnection!

Retrieve the currently active InputConnection that is bound to the input method, or null if there is none.

getCurrentInputEditorInfo

Added in API level 3
open fun getCurrentInputEditorInfo(): EditorInfo!

getCurrentInputStarted

Added in API level 3
open fun getCurrentInputStarted(): Boolean

getInputMethodWindowRecommendedHeight

Added in API level 21
Deprecated in API level 29
open fun getInputMethodWindowRecommendedHeight(): Int

Deprecated: the actual behavior of this method has never been well defined. You cannot use this method in a reliable and predictable way

Aimed to return the previous input method's Insets.contentTopInsets, but its actual semantics has never been well defined.

Note that the previous document clearly mentioned that this method could return 0 at any time for whatever reason. Now this method is just always returning 0.

Return
Int on Android android.os.Build.VERSION_CODES#Q and later devices this method always returns 0

getLayoutInflater

Added in API level 3
open fun getLayoutInflater(): LayoutInflater!

getMaxWidth

Added in API level 3
open fun getMaxWidth(): Int

Return the maximum width, in pixels, available the input method. Input methods are positioned at the bottom of the screen and, unless running in fullscreen, will generally want to be as short as possible so should compute their height based on their contents. However, they can stretch as much as needed horizontally. The function returns to you the maximum amount of space available horizontally, which you can use if needed for UI placement.

In many cases this is not needed, you can just rely on the normal view layout mechanisms to position your views within the full horizontal space given to the input method.

Note that this value can change dynamically, in particular when the screen orientation changes.

getStylusHandwritingIdleTimeoutMax

Added in API level 34
static fun getStylusHandwritingIdleTimeoutMax(): Duration

Returns the maximum stylus handwriting session idle-timeout for use with setStylusHandwritingSessionTimeout(java.time.Duration).

Return
Duration This value cannot be null.

getStylusHandwritingSessionTimeout

Added in API level 34
fun getStylusHandwritingSessionTimeout(): Duration

Returns the duration after which an ongoing stylus handwriting session that hasn't received new MotionEvents will time out and finishStylusHandwriting() will be called. The current timeout can be changed using setStylusHandwritingSessionTimeout(java.time.Duration).

Return
Duration This value cannot be null.

getStylusHandwritingWindow

Added in API level 33
fun getStylusHandwritingWindow(): Window?

Returns the stylus handwriting inking window. IMEs supporting stylus input are expected to attach their inking views to this window (e.g. with Window.setContentView(View) )). Handwriting-related MotionEvents are dispatched to the attached view hierarchy. Note: This returns null if IME doesn't support stylus handwriting i.e. if InputMethodInfo.supportsStylusHandwriting() is false. This method should be called after onStartStylusHandwriting().

getSystemService

Added in API level 3
open fun getSystemService(name: String): Any?

Return the handle to a system-level service by name. The class of the returned object varies by the requested name. Currently available names are:

WINDOW_SERVICE ("window")
The top-level window manager in which you can place custom windows. The returned object is a android.view.WindowManager. Must only be obtained from a visual context such as Activity or a Context created with createWindowContext(int,android.os.Bundle), which are adjusted to the configuration and visual bounds of an area on screen.
LAYOUT_INFLATER_SERVICE ("layout_inflater")
A android.view.LayoutInflater for inflating layout resources in this context. Must only be obtained from a visual context such as Activity or a Context created with createWindowContext(int,android.os.Bundle), which are adjusted to the configuration and visual bounds of an area on screen.
ACTIVITY_SERVICE ("activity")
A android.app.ActivityManager for interacting with the global activity state of the system.
WALLPAPER_SERVICE ("wallpaper")
A android.service.wallpaper.WallpaperService for accessing wallpapers in this context. Must only be obtained from a visual context such as Activity or a Context created with createWindowContext(int,android.os.Bundle), which are adjusted to the configuration and visual bounds of an area on screen.
POWER_SERVICE ("power")
A android.os.PowerManager for controlling power management.
ALARM_SERVICE ("alarm")
A android.app.AlarmManager for receiving intents at the time of your choosing.
NOTIFICATION_SERVICE ("notification")
A android.app.NotificationManager for informing the user of background events.
KEYGUARD_SERVICE ("keyguard")
A android.app.KeyguardManager for controlling keyguard.
LOCATION_SERVICE ("location")
A android.location.LocationManager for controlling location (e.g., GPS) updates.
SEARCH_SERVICE ("search")
A android.app.SearchManager for handling search.
VIBRATOR_MANAGER_SERVICE ("vibrator_manager")
A android.os.VibratorManager for accessing the device vibrators, interacting with individual ones and playing synchronized effects on multiple vibrators.
VIBRATOR_SERVICE ("vibrator")
A android.os.Vibrator for interacting with the vibrator hardware.
CONNECTIVITY_SERVICE ("connectivity")
A ConnectivityManager for handling management of network connections.
IPSEC_SERVICE ("ipsec")
A IpSecManager for managing IPSec on sockets and networks.
WIFI_SERVICE ("wifi")
A WifiManager for management of Wi-Fi connectivity. On releases before Android 7, it should only be obtained from an application context, and not from any other derived context to avoid memory leaks within the calling process.
WIFI_AWARE_SERVICE ("wifiaware")
A WifiAwareManager for management of Wi-Fi Aware discovery and connectivity.
WIFI_P2P_SERVICE ("wifip2p")
A WifiP2pManager for management of Wi-Fi Direct connectivity.
INPUT_METHOD_SERVICE ("input_method")
An InputMethodManager for management of input methods.
UI_MODE_SERVICE ("uimode")
An android.app.UiModeManager for controlling UI modes.
DOWNLOAD_SERVICE ("download")
A android.app.DownloadManager for requesting HTTP downloads
BATTERY_SERVICE ("batterymanager")
A android.os.BatteryManager for managing battery state
JOB_SCHEDULER_SERVICE ("taskmanager")
A android.app.job.JobScheduler for managing scheduled tasks
NETWORK_STATS_SERVICE ("netstats")
A NetworkStatsManager for querying network usage statistics.
HARDWARE_PROPERTIES_SERVICE ("hardware_properties")
A android.os.HardwarePropertiesManager for accessing hardware properties.
DOMAIN_VERIFICATION_SERVICE ("domain_verification")
A android.content.pm.verify.domain.DomainVerificationManager for accessing web domain approval state.
DISPLAY_HASH_SERVICE ("display_hash")
A android.view.displayhash.DisplayHashManager for management of display hashes.
#AUTHENTICATION_POLICY_SERVICE ("authentication_policy")
A android.security.authenticationpolicy.AuthenticationPolicyManager for managing authentication related policies on the device.

Note: System services obtained via this API may be closely associated with the Context in which they are obtained from. In general, do not share the service objects between various different contexts (Activities, Applications, Services, Providers, etc.)

Note: Instant apps, for which PackageManager.isInstantApp() returns true, don't have access to the following system services: DEVICE_POLICY_SERVICE, FINGERPRINT_SERVICE, KEYGUARD_SERVICE, SHORTCUT_SERVICE, USB_SERVICE, WALLPAPER_SERVICE, WIFI_P2P_SERVICE, WIFI_SERVICE, WIFI_AWARE_SERVICE. For these services this method will return null. Generally, if you are running as an instant app you should always check whether the result of this method is null.

Note: When implementing this method, keep in mind that new services can be added on newer Android releases, so if you're looking for just the explicit names mentioned above, make sure to return null when you don't recognize the name — if you throw a RuntimeException exception instead, your app might break on new Android releases.

Parameters
name String: This value cannot be null.
Return
Any? This value may be null.

getTextForImeAction

Added in API level 3
open fun getTextForImeAction(imeOptions: Int): CharSequence!

Return text that can be used as a button label for the given EditorInfo.imeOptions. Returns null if there is no action requested. Note that there is no guarantee that the returned text will be relatively short, so you probably do not want to use it as text on a soft keyboard key label.

Parameters
imeOptions Int: The value from EditorInfo.imeOptions.
Return
CharSequence! Returns a label to use, or null if there is no action.

getWindow

Added in API level 3
open fun getWindow(): Dialog!

hideStatusIcon

Added in API level 3
open fun hideStatusIcon(): Unit

hideWindow

Added in API level 3
open fun hideWindow(): Unit

isExtractViewShown

Added in API level 3
open fun isExtractViewShown(): Boolean

Return whether the fullscreen extract view is shown. This will only return true if isFullscreenMode() returns true, and in that case its value depends on the last call to setExtractViewShown(boolean). This effectively lets you determine if the application window is entirely covered (when this returns true) or if some part of it may be shown (if this returns false, though if isFullscreenMode() returns true in that case then it is probably only a sliver of the application).

isFullscreenMode

Added in API level 3
open fun isFullscreenMode(): Boolean

Return whether the input method is currently running in fullscreen mode. This is the mode that was last determined and applied by updateFullscreenMode().

isInputViewShown

Added in API level 3
open fun isInputViewShown(): Boolean

Return whether the soft input view is currently shown to the user. This is the state that was last determined and applied by updateInputViewShown().

isShowInputRequested

Added in API level 3
open fun isShowInputRequested(): Boolean

Returns true if we have been asked to show our input view.

onAppPrivateCommand

Added in API level 3
open fun onAppPrivateCommand(
    action: String!,
    data: Bundle!
): Unit

Not implemented in this class.

onBindInput

Added in API level 3
open fun onBindInput(): Unit

Called when a new client has bound to the input method. This may be followed by a series of onStartInput(android.view.inputmethod.EditorInfo,boolean) and onFinishInput() calls as the user navigates through its UI. Upon this call you know that getCurrentInputBinding and getCurrentInputConnection return valid objects.

onComputeInsets

Added in API level 3
open fun onComputeInsets(outInsets: InputMethodService.Insets!): Unit

Compute the interesting insets into your UI. The default implementation uses the top of the candidates frame for the visible insets, and the top of the input frame for the content insets. The default touchable insets are Insets.TOUCHABLE_INSETS_VISIBLE.

Note that this method is not called when isExtractViewShown returns true, since in that case the application is left as-is behind the input method and not impacted by anything in its UI.

Parameters
outInsets InputMethodService.Insets!: Fill in with the current UI insets.

onConfigurationChanged

Added in API level 3
open fun onConfigurationChanged(newConfig: Configuration): Unit

Take care of handling configuration changes. Subclasses of InputMethodService generally don't need to deal directly with this on their own; the standard implementation here takes care of regenerating the input method UI as a result of the configuration change, so you can rely on your onCreateInputView and other methods being called as appropriate due to a configuration change.

When a configuration change does happen, onInitializeInterface() is guaranteed to be called the next time prior to any of the other input or UI creation callbacks. The following will be called immediately depending if appropriate for current state: onStartInput if input is active, and onCreateInputView and onStartInputView and related appropriate functions if the UI is displayed.

Starting with Build.VERSION_CODES.S, IMEs can opt into handling configuration changes themselves instead of being restarted with android.R.styleable#InputMethod_configChanges.

Parameters
newConfig Configuration: The new device configuration. This value cannot be null.
configuration This value cannot be null.

onConfigureWindow

Added in API level 3
open fun onConfigureWindow(
    win: Window!,
    isFullscreen: Boolean,
    isCandidatesOnly: Boolean
): Unit

Update the given window's parameters for the given mode. This is called when the window is first displayed and each time the fullscreen or candidates only mode changes.

The default implementation makes the layout for the window MATCH_PARENT x MATCH_PARENT when in fullscreen mode, and MATCH_PARENT x WRAP_CONTENT when in non-fullscreen mode.

Parameters
win Window!: The input method's window.
isFullscreen Boolean: If true, the window is running in fullscreen mode and intended to cover the entire application display.
isCandidatesOnly Boolean: If true, the window is only showing the candidates view and none of the rest of its UI. This is mutually exclusive with fullscreen mode.

onCreate

Added in API level 3
open fun onCreate(): Unit

onCreateCandidatesView

Added in API level 3
open fun onCreateCandidatesView(): View!

Create and return the view hierarchy used to show candidates. This will be called once, when the candidates are first displayed. You can return null to have no candidates view; the default implementation returns null.

To control when the candidates view is displayed, use setCandidatesViewShown(boolean). To change the candidates view after the first one is created by this function, use setCandidatesView(android.view.View).

onCreateExtractTextView

Added in API level 3
open fun onCreateExtractTextView(): View!

Called by the framework to create the layout for showing extracted text. Only called when in fullscreen mode. The returned view hierarchy must have an ExtractEditText whose ID is android.R.id#inputExtractEditText, with action ID android.R.id#inputExtractAction and accessories ID android.R.id#inputExtractAccessories.

onCreateInlineSuggestionsRequest

Added in API level 30
open fun onCreateInlineSuggestionsRequest(uiExtras: Bundle): InlineSuggestionsRequest?

Called when Autofill is requesting an InlineSuggestionsRequest from the IME.

The Autofill Framework will first request the IME to create and send an InlineSuggestionsRequest back. Once Autofill Framework receives a valid request and also receives valid inline suggestions, they will be returned via onInlineSuggestionsResponse(android.view.inputmethod.InlineSuggestionsResponse).

IME Lifecycle - The request will wait to be created after inputStarted

If the IME wants to support displaying inline suggestions, they must set supportsInlineSuggestions in its XML and implement this method to return a valid InlineSuggestionsRequest.

Parameters
uiExtras Bundle: the extras that contain the UI renderer related information This value cannot be null.
Return
InlineSuggestionsRequest? an InlineSuggestionsRequest to be sent to Autofill. This value may be null.

onCreateInputMethodInterface

Added in API level 3
open fun onCreateInputMethodInterface(): AbstractInputMethodService.AbstractInputMethodImpl!

Deprecated: Overriding or calling this method is strongly discouraged. A future version of Android will remove the ability to use this method. Use the callbacks on InputMethodService as InputMethodService.onBindInput(), InputMethodService.onUnbindInput(), InputMethodService.onWindowShown(), InputMethodService.onWindowHidden(), etc.

Implement to return our standard InputMethodImpl.

onCreateInputMethodSessionInterface

Added in API level 3
open fun onCreateInputMethodSessionInterface(): AbstractInputMethodService.AbstractInputMethodSessionImpl!

Deprecated: Overriding or calling this method is strongly discouraged. Most methods in InputMethodSessionImpl have corresponding callbacks. Use InputMethodService.onFinishInput(), InputMethodService.onDisplayCompletions(CompletionInfo[]), InputMethodService.onUpdateExtractedText(int, ExtractedText), InputMethodService.onUpdateSelection(int, int, int, int, int, int) instead.

Implement to return our standard InputMethodSessionImpl.

IMEs targeting on Android U and above cannot override this method, or an LinkageError would be thrown.

onCreateInputView

Added in API level 3
open fun onCreateInputView(): View!

Create and return the view hierarchy used for the input area (such as a soft keyboard). This will be called once, when the input area is first displayed. You can return null to have no input area; the default implementation returns null.

To control when the input view is displayed, implement onEvaluateInputViewShown(). To change the input view after the first one is created by this function, use setInputView(android.view.View).

onCustomImeSwitcherButtonRequestedVisible

open fun onCustomImeSwitcherButtonRequestedVisible(visible: Boolean): Unit

Called when the requested visibility of a custom IME Switcher button changes.

When the system provides an IME navigation bar, it may decide to show an IME Switcher button inside this bar. However, the IME can request hiding the bar provided by the system with getWindowInsetsController().hide(captionBar()) (the IME navigation bar provides captionBar insets to the IME window). If the request is successful, then it becomes the IME's responsibility to provide a custom IME Switcher button in its input view, with equivalent functionality.

This custom button is only requested to be visible when the system provides the IME navigation bar, both the bar and the IME Switcher button inside it should be visible, but the IME successfully requested to hide the bar. This does not depend on the current visibility of the IME. It could be called with true while the IME is hidden, in which case the IME should prepare to show the button as soon as the IME itself is shown.

This is only called when the requested visibility changes. The default value is false and as such, this will not be called initially if the resulting value is false.

This can be called at any time after onCreate, even if the IME is not currently visible. However, this is not guaranteed to be called before the IME is shown, as it depends on when the IME requested hiding the IME navigation bar. If the request is sent during the showing flow (e.g. during onStartInputView), this will be called shortly after onWindowShown, but before the first IME frame is drawn.

Parameters
visible Boolean: whether the button is requested visible or not.

onDestroy

Added in API level 3
open fun onDestroy(): Unit

onDisplayCompletions

Added in API level 3
open fun onDisplayCompletions(completions: Array<CompletionInfo!>!): Unit

Called when the application has reported auto-completion candidates that it would like to have the input method displayed. Typically these are only used when an input method is running in full-screen mode, since otherwise the user can see and interact with the pop-up window of completions shown by the application.

The default implementation here does nothing.

onEvaluateFullscreenMode

Added in API level 3
open fun onEvaluateFullscreenMode(): Boolean

Override this to control when the input method should run in fullscreen mode. The default implementation runs in fullsceen only when the screen is in landscape mode. If you change what this returns, you will need to call updateFullscreenMode() yourself whenever the returned value may have changed to have it re-evaluated and applied.

onEvaluateInputViewShown

Added in API level 3
open fun onEvaluateInputViewShown(): Boolean

Override this to control when the soft input area should be shown to the user. The default implementation returns false when there is no hard keyboard or the keyboard is hidden unless the user shows an intention to use software keyboard. If you change what this returns, you will need to call updateInputViewShown() yourself whenever the returned value may have changed to have it re-evaluated and applied.

When you override this method, it is recommended to call super.onEvaluateInputViewShown() and return true when true is returned.


If you override this method you must call through to the superclass implementation.

onExtractTextContextMenuItem

Added in API level 3
open fun onExtractTextContextMenuItem(id: Int): Boolean

This is called when the user has selected a context menu item from the extracted text view, when running in fullscreen mode. The default implementation sends this action to the current InputConnection's InputConnection.performContextMenuAction(int), for it to be processed in underlying "real" editor. Re-implement this to provide whatever behavior you want.

onExtractedCursorMovement

Added in API level 3
open fun onExtractedCursorMovement(
    dx: Int,
    dy: Int
): Unit

This is called when the user has performed a cursor movement in the extracted text view, when it is running in fullscreen mode. The default implementation hides the candidates view when a vertical movement happens, but only if the extracted text editor has a vertical scroll bar because its text doesn't fit. Re-implement this to provide whatever behavior you want.

Parameters
dx Int: The amount of cursor movement in the x dimension.
dy Int: The amount of cursor movement in the y dimension.

onExtractedSelectionChanged

Added in API level 3
open fun onExtractedSelectionChanged(
    start: Int,
    end: Int
): Unit

This is called when the user has moved the cursor in the extracted text view, when running in fullsreen mode. The default implementation performs the corresponding selection change on the underlying text editor.

onExtractedTextClicked

Added in API level 3
open fun onExtractedTextClicked(): Unit

This is called when the user has clicked on the extracted text view, when running in fullscreen mode. The default implementation hides the candidates view when this happens, but only if the extracted text editor has a vertical scroll bar because its text doesn't fit. Re-implement this to provide whatever behavior you want.

onExtractingInputChanged

Added in API level 3
open fun onExtractingInputChanged(ei: EditorInfo!): Unit

This is called when, while currently displayed in extract mode, the current input target changes. The default implementation will auto-hide the IME if the new target is not a full editor, since this can be a confusing experience for the user.

onFinishCandidatesView

Added in API level 3
open fun onFinishCandidatesView(finishingInput: Boolean): Unit

Called when the candidates view is being hidden from the user. This will be called either prior to hiding the window, or prior to switching to another target for editing.

The default implementation uses the InputConnection to clear any active composing text; you can override this (not calling the base class implementation) to perform whatever behavior you would like.

Parameters
finishingInput Boolean: If true, onFinishInput will be called immediately after.

onFinishInput

Added in API level 3
open fun onFinishInput(): Unit

Called to inform the input method that text input has finished in the last editor. At this point there may be a call to onStartInput(android.view.inputmethod.EditorInfo,boolean) to perform input in a new editor, or the input method may be left idle. This method is not called when input restarts in the same editor.

The default implementation uses the InputConnection to clear any active composing text; you can override this (not calling the base class implementation) to perform whatever behavior you would like.

onFinishInputView

Added in API level 3
open fun onFinishInputView(finishingInput: Boolean): Unit

Called when the input view is being hidden from the user. This will be called either prior to hiding the window, or prior to switching to another target for editing.

The default implementation uses the InputConnection to clear any active composing text; you can override this (not calling the base class implementation) to perform whatever behavior you would like.

Parameters
finishingInput Boolean: If true, onFinishInput will be called immediately after.

onFinishStylusHandwriting

Added in API level 33
open fun onFinishStylusHandwriting(): Unit

Called when the current stylus handwriting session was finished (either by the system or via finishStylusHandwriting(). When this is called, the ink window has been made invisible, and the IME no longer intercepts handwriting-related MotionEvents.

onGenericMotionEvent

Added in API level 17
open fun onGenericMotionEvent(event: MotionEvent!): Boolean

Override this to intercept generic motion events before they are processed by the application. If you return true, the application will not itself process the event. If you return false, the normal application processing will occur as if the IME had not seen the event at all.

Parameters
event MotionEvent!: The motion event being received.
Return
Boolean True if the event was handled in this function, false otherwise.

onInitializeInterface

Added in API level 3
open fun onInitializeInterface(): Unit

This is a hook that subclasses can use to perform initialization of their interface. It is called for you prior to any of your UI objects being created, both after the service is first created and after a configuration change happens.

onInlineSuggestionsResponse

Added in API level 30
open fun onInlineSuggestionsResponse(response: InlineSuggestionsResponse): Boolean

Called when Autofill responds back with InlineSuggestionsResponse containing inline suggestions.

Should be implemented by subclasses.

Parameters
response InlineSuggestionsResponse: InlineSuggestionsResponse passed back by Autofill. This value cannot be null.
Return
Boolean Whether the IME will use and render the inline suggestions.

onKeyDown

Added in API level 3
open fun onKeyDown(
    keyCode: Int,
    event: KeyEvent!
): Boolean

Called back when a KeyEvent is forwarded from the target application.

The default implementation intercepts KeyEvent.KEYCODE_BACK if the IME is currently shown , to possibly hide it when the key goes up (if not canceled or long pressed). In addition, in fullscreen mode only, it will consume DPAD movement events to move the cursor in the extracted text view, not allowing them to perform navigation in the underlying application.

The default implementation does not take flags specified to setBackDisposition(int) into account, even on API version android.os.Build.VERSION_CODES#P and later devices. IME developers are responsible for making sure that their special handling for KeyEvent.KEYCODE_BACK are consistent with the flag they specified to setBackDisposition(int).

Parameters
keyCode Int: The value in event.getKeyCode()
event KeyEvent!: Description of the key event
Return
Boolean true if the event is consumed by the IME and the application no longer needs to consume it. Return false when the event should be handled as if the IME had not seen the event at all.

onKeyLongPress

Added in API level 5
open fun onKeyLongPress(
    keyCode: Int,
    event: KeyEvent!
): Boolean

Default implementation of KeyEvent.Callback.onKeyLongPress(): always returns false (doesn't handle the event).

Parameters
keyCode Int: The value in event.getKeyCode().
event KeyEvent!: Description of the key event.
Return
Boolean If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

onKeyMultiple

Added in API level 3
open fun onKeyMultiple(
    keyCode: Int,
    count: Int,
    event: KeyEvent!
): Boolean

Override this to intercept special key multiple events before they are processed by the application. If you return true, the application will not itself process the event. If you return false, the normal application processing will occur as if the IME had not seen the event at all.

The default implementation always returns false, except when in fullscreen mode, where it will consume DPAD movement events to move the cursor in the extracted text view, not allowing them to perform navigation in the underlying application.

Parameters
keyCode Int: The value in event.getKeyCode().
count Int: Number of pairs as returned by event.getRepeatCount().
event KeyEvent!: Description of the key event.
Return
Boolean If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

onKeyUp

Added in API level 3
open fun onKeyUp(
    keyCode: Int,
    event: KeyEvent!
): Boolean

Override this to intercept key up events before they are processed by the application. If you return true, the application will not itself process the event. If you return false, the normal application processing will occur as if the IME had not seen the event at all.

The default implementation intercepts KeyEvent.KEYCODE_BACK to hide the current IME UI if it is shown. In addition, in fullscreen mode only, it will consume DPAD movement events to move the cursor in the extracted text view, not allowing them to perform navigation in the underlying application.

Parameters
keyCode Int: The value in event.getKeyCode().
event KeyEvent!: Description of the key event.
Return
Boolean If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

onPrepareStylusHandwriting

Added in API level 33
open fun onPrepareStylusHandwriting(): Unit

Called to prepare stylus handwriting. The system calls this before the onStartStylusHandwriting request.

Note: The system tries to call this as early as possible, when it detects that handwriting stylus input is imminent. However, that a subsequent call to onStartStylusHandwriting actually happens is not guaranteed.

onShouldVerifyKeyEvent

open fun onShouldVerifyKeyEvent(keyEvent: KeyEvent): Boolean

Received by the IME before dispatch to onKeyDown(int,android.view.KeyEvent) to let the system know if the KeyEvent needs to be verified that it originated from the system. KeyEvents may originate from outside of the system and any sensitive keys should be marked for verification. One example of this could be using key shortcuts for switching to another IME.

Parameters
event This value cannot be null.
keyEvent KeyEvent: the event that may need verification. This value cannot be null.
Return
Boolean true if KeyEvent should have its HMAC verified before dispatch, false otherwise.

onShowInputRequested

Added in API level 3
open fun onShowInputRequested(
    flags: Int,
    configChange: Boolean
): Boolean

The system has decided that it may be time to show your input method. This is called due to a corresponding call to your InputMethod.showSoftInput() method. The default implementation uses onEvaluateInputViewShown(), onEvaluateFullscreenMode(), and the current configuration to decide whether the input view should be shown at this point.

Parameters
configChange Boolean: This is true if we are re-showing due to a configuration change.
flags Int: Value is either 0 or a combination of android.view.inputmethod.InputMethod#SHOW_EXPLICIT, and android.view.inputmethod.InputMethod#SHOW_FORCED
Return
Boolean Returns true to indicate that the window should be shown.

onStartCandidatesView

Added in API level 3
open fun onStartCandidatesView(
    editorInfo: EditorInfo!,
    restarting: Boolean
): Unit

Called when only the candidates view has been shown for showing processing as the user enters text through a hard keyboard. This will always be called after onStartInput, allowing you to do your general setup there and just view-specific setup here. You are guaranteed that onCreateCandidatesView() will have been called some time before this function is called.

Note that this will not be called when the input method is running in full editing mode, and thus receiving onStartInputView to initiate that operation. This is only for the case when candidates are being shown while the input method editor is hidden but wants to show its candidates UI as text is entered through some other mechanism.

Parameters
editorInfo EditorInfo!: Description of the type of text being edited.
restarting Boolean: Set to true if we are restarting input on the same text field as before.

onStartConnectionlessStylusHandwriting

Added in API level 35
open fun onStartConnectionlessStylusHandwriting(
    inputType: Int,
    cursorAnchorInfo: CursorAnchorInfo?
): Boolean

Called when an app requests to start a connectionless stylus handwriting session using one of InputMethodManager.startConnectionlessStylusHandwriting(View, CursorAnchorInfo,, android.view.inputmethod.InputMethodManager#startConnectionlessStylusHandwritingForDelegation(android.view.View,android.view.inputmethod.CursorAnchorInfo,java.util.concurrent.Executor,android.view.inputmethod.ConnectionlessHandwritingCallback), or android.view.inputmethod.InputMethodManager#startConnectionlessStylusHandwritingForDelegation(android.view.View,android.view.inputmethod.CursorAnchorInfo,java.lang.String,java.util.concurrent.Executor,android.view.inputmethod.ConnectionlessHandwritingCallback).

A connectionless stylus handwriting session differs from a regular session in that an input connection is not used to communicate with a text editor. Instead, the recognised text is delivered when the IME finishes the connectionless session using finishConnectionlessStylusHandwriting(java.lang.CharSequence).

If the IME can start the connectionless handwriting session, it should return true, ensure its inking views are attached to the getStylusHandwritingWindow(), and handle stylus input received from onStylusHandwritingMotionEvent(android.view.MotionEvent) on the getStylusHandwritingWindow().

Parameters
cursorAnchorInfo CursorAnchorInfo?: This value may be null.

onStartInput

Added in API level 3
open fun onStartInput(
    attribute: EditorInfo!,
    restarting: Boolean
): Unit

Called to inform the input method that text input has started in an editor. You should use this callback to initialize the state of your input to match the state of the editor given to it.

Parameters
attribute EditorInfo!: The attributes of the editor that input is starting in.
restarting Boolean: Set to true if input is restarting in the same editor such as because the application has changed the text in the editor. Otherwise will be false, indicating this is a new session with the editor.

onStartInputView

Added in API level 3
open fun onStartInputView(
    editorInfo: EditorInfo!,
    restarting: Boolean
): Unit

Called when the input view is being shown and input has started on a new editor. This will always be called after onStartInput, allowing you to do your general setup there and just view-specific setup here. You are guaranteed that onCreateInputView() will have been called some time before this function is called.

Parameters
editorInfo EditorInfo!: Description of the type of text being edited.
restarting Boolean: Set to true if we are restarting input on the same text field as before.

onStartStylusHandwriting

Added in API level 33
open fun onStartStylusHandwriting(): Boolean

Called when an app requests stylus handwriting InputMethodManager.startStylusHandwriting(View). This will always be preceded by onStartInput(android.view.inputmethod.EditorInfo,boolean) for the EditorInfo and InputConnection for which stylus handwriting is being requested. If the IME supports handwriting for the current input, it should return true, ensure its inking views are attached to the getStylusHandwritingWindow(), and handle stylus input received from onStylusHandwritingMotionEvent(android.view.MotionEvent) on the getStylusHandwritingWindow() via getCurrentInputConnection().

Return
Boolean true if IME can honor the request, false if IME cannot at this time.

onStylusHandwritingMotionEvent

Added in API level 33
open fun onStylusHandwritingMotionEvent(motionEvent: MotionEvent): Unit

Called after onStartStylusHandwriting() returns true for every Stylus MotionEvent. By default, this method forwards all MotionEvents to the getStylusHandwritingWindow() once its visible, however IME can override it to receive them sooner.

Parameters
motionEvent MotionEvent: MotionEvent from stylus. This value cannot be null.

onTrackballEvent

Added in API level 3
open fun onTrackballEvent(event: MotionEvent!): Boolean

Override this to intercept trackball motion events before they are processed by the application. If you return true, the application will not itself process the event. If you return false, the normal application processing will occur as if the IME had not seen the event at all.

Parameters
event MotionEvent!: The motion event being received.
Return
Boolean True if the event was handled in this function, false otherwise.

onUnbindInput

Added in API level 3
open fun onUnbindInput(): Unit

Called when the previous bound client is no longer associated with the input method. After returning getCurrentInputBinding and getCurrentInputConnection will no longer return valid objects.

onUpdateCursor

Added in API level 3
Deprecated in API level 21
open fun onUpdateCursor(newCursor: Rect!): Unit

Deprecated: Use onUpdateCursorAnchorInfo(android.view.inputmethod.CursorAnchorInfo) instead.

Called when the application has reported a new location of its text cursor. This is only called if explicitly requested by the input method. The default implementation does nothing.

onUpdateCursorAnchorInfo

Added in API level 21
open fun onUpdateCursorAnchorInfo(cursorAnchorInfo: CursorAnchorInfo!): Unit

Called when the application has reported a new location of its text insertion point and characters in the composition string. This is only called if explicitly requested by the input method. The default implementation does nothing.

Parameters
cursorAnchorInfo CursorAnchorInfo!: The positional information of the text insertion point and the composition string.

onUpdateEditorToolType

Added in API level 34
open fun onUpdateEditorToolType(toolType: Int): Unit

Called when the user tapped or clicked an editor. This can be useful when IME makes a decision of showing Virtual keyboard based on what MotionEvent.getToolType(int) was used to click the editor. e.g. when toolType is MotionEvent.TOOL_TYPE_STYLUS, IME may choose to show a companion widget instead of normal virtual keyboard.

This method is called after onStartInput(android.view.inputmethod.EditorInfo,boolean) and before onStartInputView(android.view.inputmethod.EditorInfo,boolean) when editor was clicked with a known tool type.

Default implementation does nothing.

onUpdateExtractedText

Added in API level 3
open fun onUpdateExtractedText(
    token: Int,
    text: ExtractedText!
): Unit

Called when the application has reported new extracted text to be shown due to changes in its current text state. The default implementation here places the new text in the extract edit text, when the input method is running in fullscreen mode.

onUpdateExtractingViews

Added in API level 3
open fun onUpdateExtractingViews(ei: EditorInfo!): Unit

Called when the fullscreen-mode extracting editor info has changed, to update the state of its UI such as the action buttons shown. You do not need to deal with this if you are using the standard full screen extract UI. If replacing it, you will need to re-implement this to put the appropriate action button in your own UI and handle it, and perform any other changes.

The standard implementation turns on or off its accessory area depending on whether there is an action button, and hides or shows the entire extract area depending on whether it makes sense for the current editor. In particular, a InputType.TYPE_NULL or InputType.TYPE_TEXT_VARIATION_FILTER input type will turn off the extract area since there is no text to be shown.

onUpdateExtractingVisibility

Added in API level 3
open fun onUpdateExtractingVisibility(ei: EditorInfo!): Unit

Called when the fullscreen-mode extracting editor info has changed, to determine whether the extracting (extract text and candidates) portion of the UI should be shown. The standard implementation hides or shows the extract area depending on whether it makes sense for the current editor. In particular, a InputType.TYPE_NULL input type or EditorInfo.IME_FLAG_NO_EXTRACT_UI flag will turn off the extract area since there is no text to be shown.

onUpdateSelection

Added in API level 3
open fun onUpdateSelection(
    oldSelStart: Int,
    oldSelEnd: Int,
    newSelStart: Int,
    newSelEnd: Int,
    candidatesStart: Int,
    candidatesEnd: Int
): Unit

Called when the application has reported a new selection region of the text. This is called whether or not the input method has requested extracted text updates, although if so it will not receive this call if the extracted text has changed as well.

The default implementation takes care of updating the cursor in the extract text, if it is being shown.

onViewClicked

Added in API level 14
Deprecated in API level 29
open fun onViewClicked(focusChanged: Boolean): Unit

Deprecated: The method may not be called 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. If your goal is just being notified when an on-going input is interrupted, simply monitor onFinishInput(). If your goal is to know what MotionEvent.getToolType(int) clicked on editor, use onUpdateEditorToolType(int) instead.

Called when the user tapped or clicked 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.

Parameters
focusChanged Boolean: true if the user changed the focused view by this click.

onWindowHidden

Added in API level 3
open fun onWindowHidden(): Unit

Called when the input method window has been hidden from the user, after previously being visible.

onWindowShown

Added in API level 3
open fun onWindowShown(): Unit

Called immediately before the input method window is shown to the user. You could override this to prepare for the window to be shown (update view structure etc).

requestHideSelf

Added in API level 3
open fun requestHideSelf(flags: Int): Unit

Close this input method's soft input area, removing it from the display. The input method will continue running, but the user can no longer use it to generate input by touching the screen.

requestShowSelf

Added in API level 28
fun requestShowSelf(flags: Int): Unit

Show the input method's soft input area, so the user sees the input method window and can interact with it.

sendDefaultEditorAction

Added in API level 3
open fun sendDefaultEditorAction(fromEnterKey: Boolean): Boolean

Ask the input target to execute its default action via InputConnection.performEditorAction().

For compatibility, this method does not execute a custom action even if EditorInfo.actionLabel is set. The implementor should directly call InputConnection.performEditorAction() with EditorInfo.actionId if they want to execute a custom action.

Parameters
fromEnterKey Boolean: If true, this will be executed as if the user had pressed an enter key on the keyboard, that is it will not be done if the editor has set EditorInfo.IME_FLAG_NO_ENTER_ACTION. If false, the action will be sent regardless of how the editor has set that flag.
Return
Boolean Returns a boolean indicating whether an action has been sent. If false, either the editor did not specify a default action or it does not want an action from the enter key. If true, the action was sent (or there was no input connection at all).

sendDownUpKeyEvents

Added in API level 3
open fun sendDownUpKeyEvents(keyEventCode: Int): Unit

Send the given key event code (as defined by KeyEvent) to the current input connection is a key down + key up event pair. The sent events have KeyEvent.FLAG_SOFT_KEYBOARD set, so that the recipient can identify them as coming from a software input method, and KeyEvent.FLAG_KEEP_TOUCH_MODE, so that they don't impact the current touch mode of the UI.

Note that it's discouraged to send such key events in normal operation; this is mainly for use with android.text.InputType#TYPE_NULL type text fields, or for non-rich input methods. A reasonably capable software input method should use the android.view.inputmethod.InputConnection#commitText family of methods to send text to an application, rather than sending key events.

Parameters
keyEventCode Int: The raw key code to send, as defined by KeyEvent.

sendKeyChar

Added in API level 3
open fun sendKeyChar(charCode: Char): Unit

Send the given UTF-16 character to the current input connection. Most characters will be delivered simply by calling android.view.inputmethod.InputConnection#commitText with the character; some, however, may be handled different. In particular, the enter character ('\n') will either be delivered as an action code or a raw key event, as appropriate. Consider this as a convenience method for IMEs that do not have a full implementation of actions; a fully complying IME will decide of the right action for each event and will likely never call this method except maybe to handle events coming from an actual hardware keyboard.

Parameters
charCode Char: The UTF-16 character code to send.

setBackDisposition

Added in API level 11
open fun setBackDisposition(disposition: Int): Unit

Sets the disposition mode that indicates the expected affordance for the back button.

Keep in mind that specifying this flag does not change the the default behavior of onKeyDown(int,android.view.KeyEvent). It is IME developers' responsibility for making sure that their custom implementation of onKeyDown(int,android.view.KeyEvent) is consistent with the mode specified to this API.

setCandidatesView

Added in API level 3
open fun setCandidatesView(view: View!): Unit

Replaces the current candidates view with a new one. You only need to call this when dynamically changing the view; normally, you should implement onCreateCandidatesView() and create your view when first needed by the input method.

setCandidatesViewShown

Added in API level 3
open fun setCandidatesViewShown(shown: Boolean): Unit

Controls the visibility of the candidates display area. By default it is hidden.

setExtractView

Added in API level 3
open fun setExtractView(view: View!): Unit

setExtractViewShown

Added in API level 3
open fun setExtractViewShown(shown: Boolean): Unit

Controls the visibility of the extracted text area. This only applies when the input method is in fullscreen mode, and thus showing extracted text. When false, the extracted text will not be shown, allowing some of the application to be seen behind. This is normally set for you by onUpdateExtractingVisibility. This controls the visibility of both the extracted text and candidate view; the latter since it is not useful if there is no text to see.

setInputView

Added in API level 3
open fun setInputView(view: View!): Unit

Replaces the current input view with a new one. You only need to call this when dynamically changing the view; normally, you should implement onCreateInputView() and create your view when first needed by the input method.

setStylusHandwritingRegion

fun setStylusHandwritingRegion(handwritingRegion: Region): Unit

Sets a new stylus handwriting region as user continues to write on an editor on screen. Stylus strokes that are started within the touchableRegion are treated as continuation of handwriting and all the events outside are passed-through to the IME target app, causing stylus handwriting to finish finishStylusHandwriting(). By default, WindowManager.getMaximumWindowMetrics() is handwritable and touchableRegion resets after each handwriting session.

For example, the IME can use this API to dynamically expand the stylus handwriting region on every stylus stroke as user continues to write on an editor. The region should grow around the last stroke so that a UI element below the IME window is still interactable when it is spaced sufficiently away (~2 character dimensions) from last stroke.

Note: Setting handwriting touchable region is supported on IMEs that support stylus handwriting InputMethodInfo.supportsStylusHandwriting().

Parameters
handwritingRegion Region: new stylus handwritable Region that can accept stylus touch. This value cannot be null.

setStylusHandwritingSessionTimeout

Added in API level 34
fun setStylusHandwritingSessionTimeout(duration: Duration): Unit

Sets the duration after which an ongoing stylus handwriting session that hasn't received new MotionEvents will time out and finishStylusHandwriting() will be called. The maximum allowed duration is returned by getStylusHandwritingIdleTimeoutMax(), larger values will be clamped. Note: this value is bound to the InputMethodService instance and resets to the default whenever a new instance is constructed.

Parameters
duration Duration: timeout to set. This value cannot be null.

setTheme

Added in API level 3
open fun setTheme(theme: Int): Unit

You can call this to customize the theme used by your IME's window. This theme should typically be one that derives from android.R.style#Theme_InputMethod, which is the default theme you will get. This must be set before onCreate, so you will typically call it in your constructor with the resource ID of your custom theme.

Parameters
resid The style resource describing the theme.

shouldOfferSwitchingToNextInputMethod

Added in API level 28
fun shouldOfferSwitchingToNextInputMethod(): Boolean

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.

showStatusIcon

Added in API level 3
open fun showStatusIcon(iconResId: Int): Unit

showWindow

Added in API level 3
open fun showWindow(showInput: Boolean): Unit

switchInputMethod

Added in API level 3
open fun switchInputMethod(id: String!): Unit

Force switch to a new input method, as identified by id. This input method will be destroyed, and the requested one started on the current input field.

Parameters
id String!: Unique identifier of the new input method to start.
Exceptions
java.lang.IllegalArgumentException if the input method is unknown or filtered by the rules of package visibility.

switchInputMethod

Added in API level 28
fun switchInputMethod(
    id: String!,
    subtype: InputMethodSubtype!
): Unit

Force switch to a new input method, as identified by id. This input method will be destroyed, and the requested one started on the current input field.

Parameters
id String!: Unique identifier of the new input method to start.
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.

switchToNextInputMethod

Added in API level 28
fun switchToNextInputMethod(onlyCurrentIme: Boolean): Boolean

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

Parameters
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.

switchToPreviousInputMethod

Added in API level 28
fun switchToPreviousInputMethod(): Boolean

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.

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

updateFullscreenMode

Added in API level 3
open fun updateFullscreenMode(): Unit

Re-evaluate whether the input method should be running in fullscreen mode, and update its UI if this has changed since the last time it was evaluated. This will call onEvaluateFullscreenMode() to determine whether it should currently run in fullscreen mode. You can use isFullscreenMode() to determine if the input method is currently running in fullscreen mode.

updateInputViewShown

Added in API level 3
open fun updateInputViewShown(): Unit

Re-evaluate whether the soft input area should currently be shown, and update its UI if this has changed since the last time it was evaluated. This will call onEvaluateInputViewShown() to determine whether the input view should currently be shown. You can use isInputViewShown() to determine if the input view is currently shown.

Protected methods

dump

Added in API level 3
protected open fun dump(
    fd: FileDescriptor!,
    fout: PrintWriter!,
    args: Array<String!>!
): Unit

Performs a dump of the InputMethodService's internal state. Override to add your own information to the dump.

Parameters
fd FileDescriptor!: The raw file descriptor that the dump is being sent to.
writer The PrintWriter to which you should dump your state. This will be closed for you after you return.
args Array<String!>!: additional arguments to the dump request.

onCurrentInputMethodSubtypeChanged

Added in API level 11
protected open fun onCurrentInputMethodSubtypeChanged(newSubtype: InputMethodSubtype!): Unit

Called when the subtype was changed.

Parameters
newSubtype InputMethodSubtype!: the subtype which is being changed to.