Added in API level 29

ContentCaptureContext


class ContentCaptureContext : Parcelable

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

Summary

Nested classes

Builder for ContentCaptureContext objects.

Inherited constants
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

static ContentCaptureContext

Helper that creates a ContentCaptureContext associated with the given id.

Bundle?

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

LocusId?

Gets the context id.

String

Unit
writeToParcel(parcel: Parcel, flags: Int)

Public methods

describeContents

Added in API level 29
fun describeContents(): Int
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

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
Return
String a string representation of the object.

writeToParcel

Added in API level 29
fun writeToParcel(
    parcel: Parcel,
    flags: Int
): Unit
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 android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 29
static val CREATOR: Parcelable.Creator<ContentCaptureContext!>