InputContentInfo

Kotlin |Java

class InputContentInfo : Parcelable

kotlin.Any
↳	android.view.inputmethod.InputContentInfo

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

Summary

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public constructors
`<init>(contentUri: Uri, description: ClipDescription)` Constructs `InputContentInfo` object only with mandatory data.
`<init>(contentUri: Uri, description: ClipDescription, linkUri: Uri?)` 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()`
Unit	`releasePermission()` Releases a temporary read-only access permission for content URI associated with this object.
Unit	`requestPermission()` Requests a temporary read-only access permission for content URI associated with this object.
Unit	`writeToParcel(dest: Parcel!, flags: Int)` Used to package this object into a `Parcel`.

Properties
static Parcelable.Creator<InputContentInfo!>	`CREATOR` Used to make this class parcelable.

Public constructors

<init>

Added in API level 25

InputContentInfo(
    contentUri: Uri, 
    description: ClipDescription)

Constructs InputContentInfo object only with mandatory data.

Parameters
`contentUri`	Uri: Content URI to be exported from the input method. This cannot be `null`. This value 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. This value cannot be `null`.

<init>

Added in API level 25

InputContentInfo(
    contentUri: Uri, 
    description: ClipDescription, 
    linkUri: Uri?)

Constructs InputContentInfo object with additional link URI.

Parameters
`contentUri`	Uri: Content URI to be exported from the input method. This cannot be `null`. This value 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. This value cannot be `null`.
`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`. This value may be `null`.

Exceptions
`java.security.InvalidParameterException`	if any invalid parameter is specified.

Public methods

describeContents

Added in API level 25

fun describeContents(): Int

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(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

getContentUri

Added in API level 25

fun getContentUri(): Uri

Return
`Uri`	Content URI with which the content can be obtained. This value cannot be `null`.

getDescription

Added in API level 25

fun getDescription(): ClipDescription

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

getLinkUri

Added in API level 25

fun getLinkUri(): Uri?

Return
`Uri?`	An optional `http` or `https` URI that is related to this content. This value may be `null`.

releasePermission

Added in API level 25

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

fun requestPermission(): Unit

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

fun writeToParcel(
    dest: Parcel!, 
    flags: Int
): Unit

Used to package this object into a Parcel.

Parameters
`dest`	Parcel!: The `Parcel` to be written.
`flags`	Int: The flags used for parceling.

Properties

CREATOR

Added in API level 25

static val CREATOR: Parcelable.Creator<InputContentInfo!>

Used to make this class parcelable.