InputContentInfoCompat
public
final
class
InputContentInfoCompat
extends Object
java.lang.Object | |
↳ | androidx.core.view.inputmethod.InputContentInfoCompat |
Helper for accessing features in InputContentInfo introduced after API level 13 in a backwards compatible fashion.
Summary
Public constructors | |
---|---|
InputContentInfoCompat(Uri contentUri, ClipDescription description, Uri linkUri)
Constructs |
Public methods | |
---|---|
Uri
|
getContentUri()
|
ClipDescription
|
getDescription()
|
Uri
|
getLinkUri()
|
void
|
releasePermission()
Releases a temporary read-only access permission for content URI associated with this object. |
void
|
requestPermission()
Requests a temporary read-only access permission for content URI associated with this object. |
Object
|
unwrap()
Gets the underlying framework android.view.inputmethod.InputContentInfo object. |
static
InputContentInfoCompat
|
wrap(Object inputContentInfo)
Creates an instance from a framework android.view.inputmethod.InputContentInfo object. |
Inherited methods | |
---|---|
Public constructors
InputContentInfoCompat
public InputContentInfoCompat (Uri contentUri, ClipDescription description, Uri linkUri)
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 ClipDescription.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 methods
getContentUri
public Uri getContentUri ()
Returns | |
---|---|
Uri |
content URI with which the content can be obtained. |
getDescription
public ClipDescription getDescription ()
Returns | |
---|---|
ClipDescription |
ClipDescription object that contains the metadata of #getContentUri()
such as MIME type(s). ClipDescription.getLabel() can be used for accessibility
purpose.
|
getLinkUri
public Uri getLinkUri ()
Returns | |
---|---|
Uri |
an optional http or https URI that is related to this content.
|
releasePermission
public void releasePermission ()
Releases a temporary read-only access permission for content URI associated with this object.
Does nothing if the temporary permission is not granted.
requestPermission
public void requestPermission ()
Requests a temporary read-only access permission for content URI associated with this object.
Does nothing if the temporary permission is already granted.
unwrap
public Object unwrap ()
Gets the underlying framework android.view.inputmethod.InputContentInfo object.
This method always returns null
on API <= 24.
Returns | |
---|---|
Object |
an equivalent android.view.inputmethod.InputContentInfo object, or null if
not supported.
|
wrap
public static InputContentInfoCompat wrap (Object inputContentInfo)
Creates an instance from a framework android.view.inputmethod.InputContentInfo object.
This method always returns null
on API <= 24.
Parameters | |
---|---|
inputContentInfo |
Object : an android.view.inputmethod.InputContentInfo object, or null
if none. |
Returns | |
---|---|
InputContentInfoCompat |
an equivalent InputContentInfoCompat object, or null if not
supported.
|