Skip to content

Most visited

Recently visited

navigation

InputContentInfo

public final class InputContentInfo
extends Object implements Parcelable

java.lang.Object
   ↳ android.view.inputmethod.InputContentInfo


A container object with which input methods can send content files to the target application.

Summary

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<InputContentInfo> CREATOR

Used to make this class parcelable.

Public constructors

InputContentInfo(Uri contentUri, ClipDescription description)

Constructs InputContentInfo object only with mandatory data.

InputContentInfo(Uri contentUri, ClipDescription description, Uri linkUri)

Constructs InputContentInfo object with additional link URI.

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

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.

void writeToParcel(Parcel dest, int flags)

Used to package this object into a Parcel.

Inherited methods

From class java.lang.Object
From interface android.os.Parcelable

Fields

CREATOR

added in API level 25
Creator<InputContentInfo> CREATOR

Used to make this class parcelable.

Public constructors

InputContentInfo

added in API level 25
InputContentInfo (Uri contentUri, 
                ClipDescription description)

Constructs InputContentInfo object only with mandatory data.

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.

InputContentInfo

added in API level 25
InputContentInfo (Uri contentUri, 
                ClipDescription description, 
                Uri linkUri)

Constructs InputContentInfo object with additional link URI.

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.
Throws
InvalidParameterException if any invalid parameter is specified.

Public methods

describeContents

added in API level 25
int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

getContentUri

added in API level 25
Uri getContentUri ()

Returns
Uri Content URI with which the content can be obtained.

getDescription

added in API level 25
ClipDescription getDescription ()

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 API level 25
Uri getLinkUri ()

Returns
Uri An optional http or https URI that is related to this content.

releasePermission

added in API level 25
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

added in API level 25
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.

writeToParcel

added in API level 25
void writeToParcel (Parcel dest, 
                int flags)

Used to package this object into a Parcel.

Parameters
dest Parcel: The Parcel to be written.
flags int: The flags used for parceling.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.