PickOptionRequest

Kotlin |Java

class PickOptionRequest : VoiceInteractor.Request

kotlin.Any
↳	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 or onCancel() - these methods should be overridden to define the application specific behavior.

Summary

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

Public constructors
`PickOptionRequest(prompt: VoiceInteractor.Prompt?, options: Array<VoiceInteractor.PickOptionRequest.Option!>!, extras: Bundle?)` Create a new pick option request.

Public methods
open Unit	`onPickOptionResult(finished: Boolean, selections: Array<VoiceInteractor.PickOptionRequest.Option!>!, result: Bundle!)` Called when a single option is confirmed or narrowed to one of several options.

Inherited functions

From class Request

`Unit`	`cancel()` Cancel this active request.
`Activity!`	`getActivity()` Return the current `Activity` this request is associated with. Will change if the activity is restarted such as through a configuration change.
`Context!`	`getContext()` Return the current `Context` this request is associated with. May change if the activity hosting it goes through a configuration change.
`String!`	`getName()` Return the name this request was submitted through `submitRequest(android.app.VoiceInteractor.Request,java.lang.String)`.
`Unit`	`onAttached(activity: Activity!)` The request is now attached to an activity, or being re-attached to a new activity after a configuration change.
`Unit`	`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.
`Unit`	`onDetached()` The request is being detached from an activity.
`String`	`toString()`

Public constructors

PickOptionRequest

Added in API level 23

PickOptionRequest(
    prompt: VoiceInteractor.Prompt?, 
    options: Array<VoiceInteractor.PickOptionRequest.Option!>!, 
    extras: Bundle?)

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`	Array<VoiceInteractor.PickOptionRequest.Option!>!: The set of `Option`s the user is selecting from.
`extras`	Bundle?: Additional optional information or null.

Public methods

onPickOptionResult

Added in API level 23

open fun onPickOptionResult(
    finished: Boolean, 
    selections: Array<VoiceInteractor.PickOptionRequest.Option!>!, 
    result: Bundle!
): Unit

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`	Array<VoiceInteractor.PickOptionRequest.Option!>!: Either a single `Option` or one of several `Option`s the user has narrowed the choices down to.
`result`	Bundle!: Additional optional information.