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.

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.

[Expand]

Inherited Methods

From class android.service.voice.VoiceInteractionSession.Request

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Methods

public Option[] getOptions ()

Added in API level 23

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

public CharSequence getPrompt ()

Added in API level 23

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.

public VoiceInteractor.Prompt getVoicePrompt ()

Added in API level 23

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

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

Added in API level 23

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

Added in API level 23

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).

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

Results

Classes

Class Overview

Summary

Public Methods

public Option[] getOptions ()

public CharSequence getPrompt ()

public VoiceInteractor.Prompt getVoicePrompt ()

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

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