Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Inherited Constants](https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest.Option#inhconstants) \| [Fields](https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest.Option#lfields) \| [Ctors](https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest.Option#pubctors) \| [Methods](https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest.Option#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest.Option#inhmethods)

# VoiceInteractor.PickOptionRequest.Option

*** ** * ** ***

` public static final class VoiceInteractor.PickOptionRequest.Option `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/android/os/Parcelable `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.app.VoiceInteractor.PickOptionRequest.Option |

<br />

*** ** * ** ***

Represents a single option that the user may select using their voice. The `https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest.Option#getIndex()` method should be used as a unique ID to identify the option when it is returned from the voice interactor.

## Summary

### Inherited constants

From interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`

Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`

Flag for use with `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 https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest.Option>` | `https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest.Option#CREATOR` <br /> |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest.Option#Option(java.lang.CharSequence,%20int)(https://developer.android.com/reference/java/lang/CharSequence label, int index) ` Creates an option that a user can select with their voice by matching the label or one of several synonyms. |

| ### Public methods ||
|---|---|
| ` https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest.Option` | ` https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest.Option#addSynonym(java.lang.CharSequence)(https://developer.android.com/reference/java/lang/CharSequence synonym) ` Add a synonym term to the option to indicate an alternative way the content may be matched. |
| ` int` | ` https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest.Option#countSynonyms()() ` |
| ` int` | ` https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest.Option#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` https://developer.android.com/reference/android/os/Bundle` | ` https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest.Option#getExtras()() ` Return any optional extras information associated with this option, or null if there is none. |
| ` int` | ` https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest.Option#getIndex()() ` Return the index that was supplied in the constructor. |
| ` https://developer.android.com/reference/java/lang/CharSequence` | ` https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest.Option#getLabel()() ` |
| ` https://developer.android.com/reference/java/lang/CharSequence` | ` https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest.Option#getSynonymAt(int)(int index) ` |
| ` void` | ` https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest.Option#setExtras(android.os.Bundle)(https://developer.android.com/reference/android/os/Bundle extras) ` Set optional extra information associated with this option. |
| ` void` | ` https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest.Option#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` 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 https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` 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` ` 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` ` 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 ` https://developer.android.com/reference/android/os/Parcelable ` ` abstract int` ` 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` ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `

Flatten this object in to a Parcel.

## Fields

### CREATOR

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

```
public static final Creator<VoiceInteractor.PickOptionRequest.Option> CREATOR
```

<br />

<br />

## Public constructors

### Option

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

```
public Option (CharSequence label, 
                int index)
```

Creates an option that a user can select with their voice by matching the label or one of several synonyms.

<br />

| Parameters ||
|---|---|
| `label` | `CharSequence`: The label that will both be matched against what the user speaks and displayed visually. <br /> |
| `index` | `int`: The location of this option within the overall set of options. Can be used to help identify the option when it is returned from the voice interactor. <br /> |

## Public methods

### addSynonym

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

```
public VoiceInteractor.PickOptionRequest.Option addSynonym (CharSequence synonym)
```

Add a synonym term to the option to indicate an alternative way the content may be matched.

<br />

| Parameters ||
|---|---|
| `synonym` | `CharSequence`: The synonym that will be matched against what the user speaks, but not displayed. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest.Option` | <br /> |

### countSynonyms

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

```
public int countSynonyms ()
```

<br />

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### describeContents

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

### getExtras

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

```
public Bundle getExtras ()
```

Return any optional extras information associated with this option, or null if there is none. Note that this method returns a reference to the actual extras Bundle in the option, so modifications to it will directly modify the extras in the option.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/os/Bundle` | <br /> |

### getIndex

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

```
public int getIndex ()
```

Return the index that was supplied in the constructor. If the option was constructed without an index, -1 is returned.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getLabel

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

```
public CharSequence getLabel ()
```

<br />

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/CharSequence` | <br /> |

### getSynonymAt

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

```
public CharSequence getSynonymAt (int index)
```

<br />

<br />

| Parameters ||
|---|---|
| `index` | `int` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/CharSequence` | <br /> |

### setExtras

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

```
public void setExtras (Bundle extras)
```

Set optional extra information associated with this option. Note that this method takes ownership of the supplied extras Bundle.

<br />

| Parameters ||
|---|---|
| `extras` | `Bundle` <br /> |

### writeToParcel

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

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

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `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 `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |