# ContentCaptureContext

Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Summary:[Nested Classes](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureContext#nestedclasses)\|[Inherited Constants](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureContext#inhconstants)\|[Fields](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureContext#lfields)\|[Methods](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureContext#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureContext#inhmethods)  

# ContentCaptureContext

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/view/contentcapture/ContentCaptureContext "View this page in Kotlin")\|Java

`
public

final

class
ContentCaptureContext
`  
`

extends `[Object](https://developer.android.com/reference/java/lang/Object)`


``


implements

`[Parcelable](https://developer.android.com/reference/android/os/Parcelable)`


`

|---|---------------------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.view.contentcapture.ContentCaptureContext |

<br />

*** ** * ** ***

Context associated with a[ContentCaptureSession](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureSession)- see[ContentCaptureManager](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureManager)for more info.

## Summary

|                                                                                                                                 ### Nested classes                                                                                                                                 ||
|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` class` | [ContentCaptureContext.Builder](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureContext.Builder) Builder for[ContentCaptureContext](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureContext)objects. |

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ### Inherited constants                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From interface[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable) |-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR) Descriptor bit used with[describeContents()](https://developer.android.com/reference/android/os/Parcelable#describeContents()): indicates that the Parcelable object's flattened representation includes a file descriptor.                                                                                                                                            | | `int` | [PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE) Flag for use with[writeToParcel(Parcel, int)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)): 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](https://developer.android.com/reference/android/os/Parcelable.Creator)`<`[ContentCaptureContext](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureContext)`>` | [CREATOR](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureContext#CREATOR) <br /> |

|                                                                                                                                                                                                                                                   ### Public methods                                                                                                                                                                                                                                                    ||
|------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` int`                                                                                                                       | ` `[describeContents](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureContext#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.                                                                                                                                          |
| ` static `[ContentCaptureContext](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureContext) | ` `[forLocusId](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureContext#forLocusId(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` id) ` Helper that creates a[ContentCaptureContext](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureContext)associated with the given`id`. |
| ` `[Bundle](https://developer.android.com/reference/android/os/Bundle)                                                       | ` `[getExtras](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureContext#getExtras())`() ` Gets the (optional) extras set by the app (through[Builder.setExtras(Bundle)](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureContext.Builder#setExtras(android.os.Bundle))).                                                |
| ` `[LocusId](https://developer.android.com/reference/android/content/LocusId)                                                | ` `[getLocusId](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureContext#getLocusId())`() ` Gets the context id.                                                                                                                                                                                                                                         |
| ` `[String](https://developer.android.com/reference/java/lang/String)                                                        | ` `[toString](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureContext#toString())`() ` Returns a string representation of the object.                                                                                                                                                                                                                   |
| ` void`                                                                                                                      | ` `[writeToParcel](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureContext#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` parcel, int flags) ` Flatten this object in to a Parcel.                                                                                                     |

| ### Inherited methods |
|-----------------------|---|
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object)          | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object.                                                                                                                                                      | | ` boolean`                                                                     | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one.                                           | | ` void`                                                                        | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.                                                          | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`<?>` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`.                                                                                                                                                | | ` int`                                                                         | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                 | | ` final void`                                                                  | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor.                                                                                                                            | | ` final void`                                                                  | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor.                                                                                                                         | | ` `[String](https://developer.android.com/reference/java/lang/String)          | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object.                                                                                                                                            | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(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](https://developer.android.com/reference/java/lang/Object#wait(long))`(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](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*.                                                                                             | ||
| From interface` `[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable)` ` |------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract int`  | ` `[describeContents](https://developer.android.com/reference/android/os/Parcelable#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.                                    | | ` abstract void` | ` `[writeToParcel](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel. | ||

## Fields

### CREATOR

Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public static final Creator<ContentCaptureContext> CREATOR
```

<br />

<br />

## Public methods

### describeContents

Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
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)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)), the return value of this method must include the[CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR)bit.

<br />

|                                                                                                                         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](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR) <br /> |

### forLocusId

Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public static ContentCaptureContext forLocusId (String id)
```

Helper that creates a[ContentCaptureContext](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureContext)associated with the given`id`.

<br />

|                     Parameters                     ||
|------|----------------------------------------------|
| `id` | `String`: This value cannot be`null`. <br /> |

|                                                                        Returns                                                                         ||
|--------------------------------------------------------------------------------------------------------------------|------------------------------------|
| [ContentCaptureContext](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureContext) | This value cannot be`null`. <br /> |

### getExtras

Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public Bundle getExtras ()
```

Gets the (optional) extras set by the app (through[Builder.setExtras(Bundle)](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureContext.Builder#setExtras(android.os.Bundle))).

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

<br />

|                                               Returns                                                ||
|---------------------------------------------------------------------|---------------------------------|
| [Bundle](https://developer.android.com/reference/android/os/Bundle) | This value may be`null`. <br /> |

### getLocusId

Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public LocusId getLocusId ()
```

Gets the context id.

<br />

|                                                   Returns                                                   ||
|----------------------------------------------------------------------------|---------------------------------|
| [LocusId](https://developer.android.com/reference/android/content/LocusId) | This value may be`null`. <br /> |

### toString

Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public String toString ()
```

Returns a string representation of the object.

<br />

|                                                      Returns                                                      ||
|--------------------------------------------------------------------|-----------------------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | a string representation of the object. <br /> |

### writeToParcel

Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public void writeToParcel (Parcel parcel, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

|                                                                                                                                                                                                                                Parameters                                                                                                                                                                                                                                ||
|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `parcel` | `Parcel`: The Parcel in which the object should be written. This value cannot be`null`. <br />                                                                                                                                                                                                                                                                                                                                                                 |
| `flags`  | `int`: Additional flags about how the object should be written. May be 0 or[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE). Value is either`0`or a combination of[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE), and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES <br /> |