Added in API level 25

Summary: Inherited Constants | Fields | Ctors | Methods | Inherited Methods

InputContentInfo

Kotlin |Java

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

`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(Parcel, int)`: 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)`".

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 the 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

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 25

public static final Creator<InputContentInfo> CREATOR

Used to make this class parcelable.

Public constructors

InputContentInfo

Added in API level 25

public 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 `ClipDescription#getLabel()` should be describing the content specified by `contentUri` for accessibility reasons.

InputContentInfo

Added in API level 25

public 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 `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`.

Throws
`InvalidParameterException`	if any invalid parameter is specified.

Public methods

describeContents

Added in API level 25

public 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(android.os.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. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getContentUri

Added in API level 25

public Uri getContentUri ()

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

getDescription

Added in API level 25

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. This value cannot be `null`.

getLinkUri

Added in API level 25

public Uri getLinkUri ()

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

releasePermission

Added in API level 25

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

Added in API level 25

public void requestPermission ()

Requests a temporary read-only access permission for the 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.

writeToParcel

Added in API level 25

public 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.