InputContentInfoCompat

Added in 1.1.0

class InputContentInfoCompat

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

Summary

Public constructors
InputContentInfoCompat(
    contentUri: Uri,
    description: ClipDescription,
    linkUri: Uri?
)

Constructs InputContentInfoCompat.

Public functions
Uri
ClipDescription
Uri?
Unit

Releases a temporary read-only access permission for content URI associated with this object.
Unit

Requests a temporary read-only access permission for content URI associated with this object.
Any?

Gets the underlying framework android.view.inputmethod.InputContentInfo object.
java-static InputContentInfoCompat?
wrap(inputContentInfo: Any?)

Creates an instance from a framework android.view.inputmethod.InputContentInfo object.

Public constructors

InputContentInfoCompat

Added in 1.1.0
InputContentInfoCompat(
    contentUri: Uri,
    description: ClipDescription,
    linkUri: Uri?
)

Constructs InputContentInfoCompat.

Parameters
contentUri: Uri

content URI to be exported from the input method. This cannot be null.
description: ClipDescription

a ClipDescription object that contains the metadata of contentUri such as MIME type(s). This object cannot be null. Also getLabel should be describing the content specified by contentUri for accessibility reasons.
linkUri: Uri?

an optional http or https URI. The editor author may provide a way to navigate the user to the specified web page if this is not null.

Public functions

getContentUri

Added in 1.1.0
fun getContentUri(): Uri
Returns
Uri

content URI with which the content can be obtained.

getDescription

Added in 1.1.0
fun getDescription(): ClipDescription
Returns
ClipDescription

ClipDescription object that contains the metadata of #getContentUri() such as MIME type(s). getLabel can be used for accessibility purpose.

getLinkUri

Added in 1.1.0
fun getLinkUri(): Uri?
Returns
Uri?

an optional http or https URI that is related to this content.

releasePermission

Added in 1.1.0
fun releasePermission(): Unit

Releases a temporary read-only access permission for content URI associated with this object.

Does nothing if the temporary permission is not granted.

requestPermission

Added in 1.1.0
fun requestPermission(): Unit

Requests a temporary read-only access permission for content URI associated with this object.

The lifecycle of the permission granted here is tied to this object instance. If the permission is not released explicitly via releasePermission, it will be released automatically when there are no more references to this object.

Does nothing if the temporary permission is already granted.

unwrap

Added in 1.1.0
fun unwrap(): Any?

Gets the underlying framework android.view.inputmethod.InputContentInfo object.

This method always returns null on API <= 24.

Returns
Any?

an equivalent android.view.inputmethod.InputContentInfo object, or null if not supported.

wrap

Added in 1.1.0
java-static fun wrap(inputContentInfo: Any?): InputContentInfoCompat?

Creates an instance from a framework android.view.inputmethod.InputContentInfo object.

This method always returns null on API <= 24.

Parameters
inputContentInfo: Any?

an android.view.inputmethod.InputContentInfo object, or null if none.
Returns
InputContentInfoCompat?

an equivalent InputContentInfoCompat object, or null if not supported.