added in API level 23

VoiceInteractionSession.PickOptionRequest

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

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