Added in API level 23

Summary: Nested Classes | Ctors | Methods | Inherited Methods

VoiceInteractor.PickOptionRequest

---

Kotlin |Java

public static class VoiceInteractor.PickOptionRequest
extends VoiceInteractor.Request

java.lang.Object
↳	android.app.VoiceInteractor.Request
	↳	android.app.VoiceInteractor.PickOptionRequest

---

Select a single option from multiple potential options with the user via the trusted system VoiceInteractionService. Typically, the application would present this visually as a list view to allow selecting the option by touch. The result of the confirmation will be returned through an asynchronous call to either onPickOptionResult(boolean, Option, Bundle) or VoiceInteractor.Request.onCancel() - these methods should be overridden to define the application specific behavior.

Summary

Nested classes
class	VoiceInteractor.PickOptionRequest.Option Represents a single option that the user may select using their voice.

Public constructors
PickOptionRequest(VoiceInteractor.Prompt prompt, Option[] options, Bundle extras) Create a new pick option request.

Public methods
void	onPickOptionResult(boolean finished, Option[] selections, Bundle result) Called when a single option is confirmed or narrowed to one of several options.

Inherited methods
From class android.app.VoiceInteractor.Request void cancel() Cancel this active request. Activity getActivity() Return the current Activity this request is associated with. Context getContext() Return the current Context this request is associated with. String getName() Return the name this request was submitted through VoiceInteractor.submitRequest(android.app.VoiceInteractor.Request, java.lang.String). void onAttached(Activity activity) The request is now attached to an activity, or being re-attached to a new activity after a configuration change. void onCancel() Report from voice interaction service: this operation has been canceled, typically as a completion of a previous call to cancel() or when the user explicitly cancelled. void onDetached() The request is being detached from an activity. 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 constructors

PickOptionRequest

Added in API level 23

public PickOptionRequest (VoiceInteractor.Prompt prompt, 
                Option[] options, 
                Bundle extras)

Create a new pick option request.

Parameters
prompt	VoiceInteractor.Prompt: Optional question to be asked of the user when the options are presented or null if nothing should be asked.
options	Option: The set of Options the user is selecting from.
extras	Bundle: Additional optional information or null.

Public methods

onPickOptionResult

Added in API level 23

public void onPickOptionResult (boolean finished, 
                Option[] selections, 
                Bundle result)

Called when a single option is confirmed or narrowed to one of several options. Override this method to define the behavior when the user selects an option or narrows down the set of options.

Parameters
finished	boolean: True if the voice interaction has finished making a selection, in which case selections contains the final result. If false, this request is still active and you will continue to get calls on it.
selections	Option: Either a single Option or one of several Options the user has narrowed the choices down to.
result	Bundle: Additional optional information.