Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Methods](https://developer.android.com/reference/android/service/voice/VoiceInteractionSession.PickOptionRequest#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/service/voice/VoiceInteractionSession.PickOptionRequest#inhmethods)

# VoiceInteractionSession.PickOptionRequest

*** ** * ** ***

` public static final class VoiceInteractionSession.PickOptionRequest `   
` ` ` extends https://developer.android.com/reference/android/service/voice/VoiceInteractionSession.Request ` ` `

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) |||
| ↳ | [android.service.voice.VoiceInteractionSession.Request](https://developer.android.com/reference/android/service/voice/VoiceInteractionSession.Request) ||
|   | ↳ | android.service.voice.VoiceInteractionSession.PickOptionRequest |

<br />

*** ** * ** ***

A request for the user to pick from a set of option, as per `https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest`.

## Summary

| ### Public methods ||
|---|---|
| ` https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest.Option` | ` https://developer.android.com/reference/android/service/voice/VoiceInteractionSession.PickOptionRequest#getOptions()() ` Return the set of options the user is picking from, as per `https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest`. |
| ` https://developer.android.com/reference/java/lang/CharSequence` | ` https://developer.android.com/reference/android/service/voice/VoiceInteractionSession.PickOptionRequest#getPrompt()() ` *This method was deprecated in API level 23. Prefer `https://developer.android.com/reference/android/service/voice/VoiceInteractionSession.PickOptionRequest#getVoicePrompt()` which allows multiple voice prompts.* |
| ` https://developer.android.com/reference/android/app/VoiceInteractor.Prompt` | ` https://developer.android.com/reference/android/service/voice/VoiceInteractionSession.PickOptionRequest#getVoicePrompt()() ` Return the prompt informing the user of what they are picking, as per `https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest`. |
| ` void` | ` https://developer.android.com/reference/android/service/voice/VoiceInteractionSession.PickOptionRequest#sendIntermediatePickOptionResult(android.app.VoiceInteractor.PickOptionRequest.Option[],%20android.os.Bundle)(https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest.Option selections, https://developer.android.com/reference/android/os/Bundle result) ` Report an intermediate option selection from the request, without completing it (the request is still active and the app is waiting for the final option selection), resulting in a call to `https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest#onPickOptionResult(boolean,%20android.app.VoiceInteractor.PickOptionRequest.Option[],%20android.os.Bundle)` with false for finished. |
| ` void` | ` https://developer.android.com/reference/android/service/voice/VoiceInteractionSession.PickOptionRequest#sendPickOptionResult(android.app.VoiceInteractor.PickOptionRequest.Option[],%20android.os.Bundle)(https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest.Option selections, https://developer.android.com/reference/android/os/Bundle result) ` Report the final option selection for the request, completing the request and resulting in a call to `https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest#onPickOptionResult(boolean,%20android.app.VoiceInteractor.PickOptionRequest.Option[],%20android.os.Bundle)` with false for finished. |

### Inherited methods

From class ` https://developer.android.com/reference/android/service/voice/VoiceInteractionSession.Request ` ` void` ` https://developer.android.com/reference/android/service/voice/VoiceInteractionSession.Request#cancel()() `

Ask the app to cancel this current request.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/android/service/voice/VoiceInteractionSession.Request#getCallingPackage()() `

Return the package name of the application that initiated the request.
` int` ` https://developer.android.com/reference/android/service/voice/VoiceInteractionSession.Request#getCallingUid()() `

Return the uid of the application that initiated the request.
` https://developer.android.com/reference/android/os/Bundle` ` https://developer.android.com/reference/android/service/voice/VoiceInteractionSession.Request#getExtras()() `

Return any additional extra information that was supplied as part of the request.
` boolean` ` https://developer.android.com/reference/android/service/voice/VoiceInteractionSession.Request#isActive()() `

Check whether this request is currently active.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/android/service/voice/VoiceInteractionSession.Request#toString()() `

Returns a string representation of the object.
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*.

## Public methods

### getOptions

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

```
public Option[] getOptions ()
```

Return the set of options the user is picking from, as per `https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest`.

<br />

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

### getPrompt

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

```
public CharSequence getPrompt ()
```

<br />

**This method was deprecated in API level 23.**   

Prefer `https://developer.android.com/reference/android/service/voice/VoiceInteractionSession.PickOptionRequest#getVoicePrompt()` which allows multiple voice prompts.

Return the prompt informing the user of what they are picking, as per `https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest`.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/CharSequence` | This value may be `null`. <br /> |

### getVoicePrompt

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

```
public VoiceInteractor.Prompt getVoicePrompt ()
```

Return the prompt informing the user of what they are picking, as per `https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest`.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/app/VoiceInteractor.Prompt` | This value may be `null`. <br /> |

### sendIntermediatePickOptionResult

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

```
public void sendIntermediatePickOptionResult (Option[] selections, 
                Bundle result)
```

Report an intermediate option selection from the request, without completing it (the request is still active and the app is waiting for the final option selection), resulting in a call to `https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest#onPickOptionResult(boolean,%20android.app.VoiceInteractor.PickOptionRequest.Option[],%20android.os.Bundle)` with false for finished.

<br />

| Parameters ||
|---|---|
| `selections` | `Option` <br /> |
| `result` | `Bundle` <br /> |

### sendPickOptionResult

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

```
public void sendPickOptionResult (Option[] selections, 
                Bundle result)
```

Report the final option selection for the request, completing the request and resulting in a call to `https://developer.android.com/reference/android/app/VoiceInteractor.PickOptionRequest#onPickOptionResult(boolean,%20android.app.VoiceInteractor.PickOptionRequest.Option[],%20android.os.Bundle)` with false for finished. This finishes the request (it is no longer active).

<br />

| Parameters ||
|---|---|
| `selections` | `Option` <br /> |
| `result` | `Bundle` <br /> |