lightbulb_outline Help shape the future of the Google Play Console, Android Studio, and Firebase. Start survey

VoiceInteractor.PickOptionRequest

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, VoiceInteractor.PickOptionRequest.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

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

Public constructors

VoiceInteractor.PickOptionRequest

added in API level 23
public VoiceInteractor.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 VoiceInteractor.PickOptionRequest.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 VoiceInteractor.PickOptionRequest.Option or one of several VoiceInteractor.PickOptionRequest.Options the user has narrowed the choices down to.

result Bundle: Additional optional information.