ContentCaptureContext

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

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

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