InputConnectionCompat

Kotlin |Java

class InputConnectionCompat

kotlin.Any
↳	androidx.core.view.inputmethod.InputConnectionCompat

Helper for accessing features in InputConnection introduced after API level 13 in a backwards compatible fashion.

Summary

Nested classes
abstract	`OnCommitContentListener` Listener for commitContent method call, in a backwards compatible fashion.

Constants
static Int	`INPUT_CONTENT_GRANT_READ_URI_PERMISSION` When this flag is used, the editor will be able to request temporary access permissions to the content URI contained in the `InputContentInfoCompat` object, in a similar manner that has been recommended in Sharing Files.

Public constructors
`<init>()`

Public methods
static Boolean	`commitContent(@NonNull inputConnection: InputConnection, @NonNull editorInfo: EditorInfo, @NonNull inputContentInfo: InputContentInfoCompat, flags: Int, @Nullable opts: Bundle?)` Calls commitContent API, in a backwards compatible fashion.
static InputConnection	`createWrapper(@NonNull inputConnection: InputConnection, @NonNull editorInfo: EditorInfo, @NonNull onCommitContentListener: InputConnectionCompat.OnCommitContentListener)` Creates a wrapper `InputConnection` object from an existing `InputConnection` and `OnCommitContentListener` that can be returned to the system.

Constants

INPUT_CONTENT_GRANT_READ_URI_PERMISSION

static val INPUT_CONTENT_GRANT_READ_URI_PERMISSION: Int

When this flag is used, the editor will be able to request temporary access permissions to the content URI contained in the InputContentInfoCompat object, in a similar manner that has been recommended in Sharing Files.

Make sure that the content provider owning the Uri sets the grantUriPermissions attribute in its manifest or included the <grant-uri-permissions> tag.

Supported only on API >= 25.

On API <= 24 devices, IME developers need to ensure that the content URI is accessible only from the target application, for example, by generating a URL with a unique name that others cannot guess. IME developers can also rely on the following information of the target application to do additional access checks in their android.content.ContentProvider.

On API >= 23 EditorInfo#packageName is guaranteed to not be spoofed, which can later be compared with android.content.ContentProvider#getCallingPackage() in the android.content.ContentProvider.
android.view.inputmethod.InputBinding#getUid() is guaranteed to not be spoofed, which can later be compared with android.os.Binder#getCallingUid() in the android.content.ContentProvider.

Value: 0x00000001

Public constructors

<init>

InputConnectionCompat()

Deprecated: This type should not be instantiated as it contains only static methods.

Public methods

commitContent

static fun commitContent(
    @NonNull inputConnection: InputConnection, 
    @NonNull editorInfo: EditorInfo, 
    @NonNull inputContentInfo: InputContentInfoCompat, 
    flags: Int, 
    @Nullable opts: Bundle?
): Boolean

Calls commitContent API, in a backwards compatible fashion.

Parameters
`inputConnection`	InputConnection: `InputConnection` with which commitContent API will be called
`editorInfo`	EditorInfo: `EditorInfo` associated with the given `inputConnection`
`inputContentInfo`	InputContentInfoCompat: content information to be passed to the editor
`flags`	Int: `0` or `INPUT_CONTENT_GRANT_READ_URI_PERMISSION`
`opts`	Bundle?: optional bundle data. This can be `null`

Return
`Boolean`	`true` if this request is accepted by the application, no matter if the request is already handled or still being handled in background

createWrapper

@NonNull static fun createWrapper(
    @NonNull inputConnection: InputConnection, 
    @NonNull editorInfo: EditorInfo, 
    @NonNull onCommitContentListener: InputConnectionCompat.OnCommitContentListener
): InputConnection

Creates a wrapper InputConnection object from an existing InputConnection