Added in API level 29

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

ContentCaptureContext

Kotlin |Java

public final class ContentCaptureContext
extends Object implements Parcelable

java.lang.Object
↳	android.view.contentcapture.ContentCaptureContext

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

Summary

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

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<ContentCaptureContext>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`static ContentCaptureContext`	`forLocusId(String id)` 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.
`void`	`writeToParcel(Parcel parcel, int flags)` Flatten this object in to 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 29

public static final Creator<ContentCaptureContext> CREATOR

Public methods

describeContents

Added in API level 29

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`

forLocusId

Added in API level 29

public static ContentCaptureContext forLocusId (String id)

Helper that creates a ContentCaptureContext associated with the given id.

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

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

getExtras

Added in API level 29

public Bundle getExtras ()

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.

Returns
`Bundle`	This value may be `null`.

getLocusId

Added in API level 29

public LocusId getLocusId ()

Gets the context id.

Returns
`LocusId`	This value may be `null`.

toString

Added in API level 29

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 29

public void writeToParcel (Parcel parcel, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`parcel`	`Parcel`: 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.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

ContentCaptureContext

Summary

Nested classes

Inherited constants

Fields

Public methods

Inherited methods

Fields

CREATOR

Public methods

describeContents

forLocusId

getExtras

getLocusId

toString

writeToParcel