AccessibilityService.SoftKeyboardController Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Used to control, query, and listen for changes to the soft keyboard show mode.
[Android.Runtime.Register("android/accessibilityservice/AccessibilityService$SoftKeyboardController", ApiSince=24, DoNotGenerateAcw=true)]
public sealed class AccessibilityService.SoftKeyboardController : Java.Lang.Object[<Android.Runtime.Register("android/accessibilityservice/AccessibilityService$SoftKeyboardController", ApiSince=24, DoNotGenerateAcw=true)>]
type AccessibilityService.SoftKeyboardController = class
inherit Object- Inheritance
- Attributes
Remarks
Used to control, query, and listen for changes to the soft keyboard show mode.
Accessibility services may request to override the decisions normally made about whether or not the soft keyboard is shown.
If multiple services make conflicting requests, the last request is honored. A service may register a listener to find out if the mode has changed under it.
If the user takes action to override the behavior behavior requested by an accessibility service, the user's request takes precendence, the show mode will be reset to AccessibilityService#SHOW_MODE_AUTO, and services will no longer be able to control that aspect of the soft keyboard's behavior.
Note: Because soft keyboards are independent apps, the framework does not have total control over their behavior. They may choose to show themselves, or not, without regard to requests made here. So the framework will make a best effort to deliver the behavior requested, but cannot guarantee success.
Java documentation for android.accessibilityservice.AccessibilityService.SoftKeyboardController.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.
Fields
| EnableImeFailByAdmin |
Obsolete.
Return value for |
| EnableImeFailUnknown |
Obsolete.
Return value for |
| EnableImeSuccess |
Obsolete.
Return value for |
Properties
| Class |
Returns the runtime class of this |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| JniIdentityHashCode | (Inherited from Object) |
| JniPeerMembers | |
| PeerReference | (Inherited from Object) |
| ShowMode |
Returns the show mode of the soft keyboard. |
| ThresholdClass |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object) |
| ThresholdType |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object) |
Methods
| AddOnShowModeChangedListener(AccessibilityService+SoftKeyboardController+IOnShowModeChangedListener) | |
| AddOnShowModeChangedListener(AccessibilityService+SoftKeyboardController+IOnShowModeChangedListener, Handler) | |
| Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
| Dispose() | (Inherited from Object) |
| Dispose(Boolean) | (Inherited from Object) |
| Equals(Object) |
Indicates whether some other object is "equal to" this one. (Inherited from Object) |
| GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
| JavaFinalize() |
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object) |
| Notify() |
Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object) |
| NotifyAll() |
Wakes up all threads that are waiting on this object's monitor. (Inherited from Object) |
| RemoveOnShowModeChangedListener(AccessibilityService+SoftKeyboardController+IOnShowModeChangedListener) | |
| SetHandle(IntPtr, JniHandleOwnership) |
Sets the Handle property. (Inherited from Object) |
| SetInputMethodEnabled(String, Boolean) |
Enable or disable the specified IME for the user for whom the service is activated. |
| SetShowMode(AccessibilityServiceShowMode) |
Sets the soft keyboard show mode. |
| SwitchToInputMethod(String) |
Switches the current IME for the user for whom the service is enabled. |
| ToArray<T>() | (Inherited from Object) |
| ToString() |
Returns a string representation of the object. (Inherited from Object) |
| UnregisterFromRuntime() | (Inherited from Object) |
| Wait() |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object) |
| Wait(Int64) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
| Wait(Int64, Int32) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
Events
| ShowModeChanged |
Explicit Interface Implementations
| IJavaPeerable.Disposed() | (Inherited from Object) |
| IJavaPeerable.DisposeUnlessReferenced() | (Inherited from Object) |
| IJavaPeerable.Finalized() | (Inherited from Object) |
| IJavaPeerable.JniManagedPeerState | (Inherited from Object) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) | (Inherited from Object) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) | (Inherited from Object) |
| IJavaPeerable.SetPeerReference(JniObjectReference) | (Inherited from Object) |
Extension Methods
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) | |
| GetJniTypeName(IJavaPeerable) | |