VoiceInteractionSession.PickOptionRequest

Kotlin |Java

public static final class VoiceInteractionSession.PickOptionRequest
extends VoiceInteractionSession.Request

java.lang.Object
↳	android.service.voice.VoiceInteractionSession.Request
	↳	android.service.voice.VoiceInteractionSession.PickOptionRequest

A request for the user to pick from a set of option, as per VoiceInteractor.PickOptionRequest.

Summary

Public methods
`Option[]`	`getOptions()` Return the set of options the user is picking from, as per `VoiceInteractor.PickOptionRequest`.
`CharSequence`	`getPrompt()` This method was deprecated in API level 23. Prefer `getVoicePrompt()` which allows multiple voice prompts.
`VoiceInteractor.Prompt`	`getVoicePrompt()` Return the prompt informing the user of what they are picking, as per `VoiceInteractor.PickOptionRequest`.
`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 `VoiceInteractor.PickOptionRequest.onPickOptionResult` with false for finished.
`void`	`sendPickOptionResult(Option[] selections, Bundle result)` Report the final option selection for the request, completing the request and resulting in a call to `VoiceInteractor.PickOptionRequest.onPickOptionResult` with false for finished.

Inherited methods

From class


        
          android.service.voice.VoiceInteractionSession.Request

`void`	`cancel()` Ask the app to cancel this current request.
`String`	`getCallingPackage()` Return the package name of the application that initiated the request.
`int`	`getCallingUid()` Return the uid of the application that initiated the request.
`Bundle`	`getExtras()` Return any additional extra information that was supplied as part of the request.
`boolean`	`isActive()` Check whether this request is currently active.
`String`	`toString()` Returns a string representation of the object.

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.

Public methods

getOptions

Added in API level 23

public Option[] getOptions ()

Return the set of options the user is picking from, as per VoiceInteractor.PickOptionRequest.

Returns
`Option[]`

getPrompt

Added in API level 23
Deprecated in API level 23

public CharSequence getPrompt ()

This method was deprecated in API level 23.
Prefer getVoicePrompt() which allows multiple voice prompts.

Return the prompt informing the user of what they are picking, as per VoiceInteractor.PickOptionRequest.

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

getVoicePrompt

Added in API level 23

public VoiceInteractor.Prompt getVoicePrompt ()

Return the prompt informing the user of what they are picking, as per VoiceInteractor.PickOptionRequest.

Returns
`VoiceInteractor.Prompt`	This value may be `null`.

sendIntermediatePickOptionResult

Added in API level 23

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 VoiceInteractor.PickOptionRequest.onPickOptionResult with false for finished.

Parameters
`selections`	`Option`
`result`	`Bundle`

sendPickOptionResult

Added in API level 23

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

Report the final option selection for the request, completing the request and resulting in a call to VoiceInteractor.PickOptionRequest.onPickOptionResult with false for finished. This finishes the request (it is no longer active).

Parameters
`selections`	`Option`
`result`	`Bundle`