ContentCaptureContext

Kotlin |Java

class ContentCaptureContext : Parcelable

kotlin.Any
↳	android.view.contentcapture.ContentCaptureContext

Context associated with a ContentCaptureSession - see ContentCaptureManager for more info.

Summary

Nested classes
	`Builder` Builder for `ContentCaptureContext` objects.

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 methods
Int	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
static ContentCaptureContext	`forLocusId(id: String)` Helper that creates a `ContentCaptureContext` associated with the given `id`.
Bundle?	`getExtras()` Gets the (optional) extras set by the app (through `Builder.setExtras(Bundle)`).
LocusId?	`getLocusId()` Gets the context id.
String	`toString()` Returns a string representation of the object.
Unit	`writeToParcel(parcel: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<ContentCaptureContext!>	`CREATOR`

Public methods

describeContents

Added in API level 29

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 `CONTENTS_FILE_DESCRIPTOR`

forLocusId

Added in API level 29

static fun forLocusId(id: String): ContentCaptureContext

Helper that creates a ContentCaptureContext associated with the given id.

Parameters
`id`	String: This value cannot be `null`.

Return
`ContentCaptureContext`	This value cannot be `null`.

getExtras

Added in API level 29

fun getExtras(): Bundle?

Gets the (optional) extras set by the app (through Builder.setExtras(Bundle)).

It can be used to provide vendor-specific data that can be modified and examined.

Return
`Bundle?`	This value may be `null`.

getLocusId

Added in API level 29

fun getLocusId(): LocusId?

Gets the context id.

Return
`LocusId?`	This value may be `null`.

toString

Added in API level 29

fun toString(): String

Returns a string representation of the object.

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 29

fun writeToParcel(
    parcel: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
`dest`	The Parcel in which the object should be written. This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: `PARCELABLE_WRITE_RETURN_VALUE`

Properties

CREATOR

Added in API level 29

static val CREATOR: Parcelable.Creator<ContentCaptureContext!>