Android APIs
public static class

VoiceInteractor.Prompt

extends Object
implements Parcelable
java.lang.Object
   ↳ android.app.VoiceInteractor.Prompt

Class Overview

A set of voice prompts to use with the voice interaction system to confirm an action, select an option, or do similar operations. Multiple voice prompts may be provided for variety. A visual prompt must be provided, which might not match the spoken version. For example, the confirmation "Are you sure you want to purchase this item?" might use a visual label like "Purchase item".

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<VoiceInteractor.Prompt> CREATOR
Public Constructors
VoiceInteractor.Prompt(CharSequence[] voicePrompts, CharSequence visualPrompt)
Constructs a prompt set.
VoiceInteractor.Prompt(CharSequence prompt)
Constructs a prompt set with single prompt used for all interactions.
Public Methods
int countVoicePrompts()
Returns the number of different voice prompts.
int describeContents()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
CharSequence getVisualPrompt()
Returns the prompt to use for visual display.
CharSequence getVoicePromptAt(int index)
Returns a prompt to use for voice interactions.
String toString()
Returns a string containing a concise, human-readable description of this object.
void writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static final Creator<VoiceInteractor.Prompt> CREATOR

Added in API level 23

Public Constructors

public VoiceInteractor.Prompt (CharSequence[] voicePrompts, CharSequence visualPrompt)

Added in API level 23

Constructs a prompt set.

Parameters
voicePrompts An array of one or more voice prompts. Must not be empty or null.
visualPrompt A prompt to display on the screen. Must not be null.

public VoiceInteractor.Prompt (CharSequence prompt)

Added in API level 23

Constructs a prompt set with single prompt used for all interactions. This is most useful in test apps. Non-trivial apps should prefer the detailed constructor.

Public Methods

public int countVoicePrompts ()

Added in API level 23

Returns the number of different voice prompts.

public int describeContents ()

Added in API level 23

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Returns
  • a bitmask indicating the set of special object types marshalled by the Parcelable.

public CharSequence getVisualPrompt ()

Added in API level 23

Returns the prompt to use for visual display.

public CharSequence getVoicePromptAt (int index)

Added in API level 23

Returns a prompt to use for voice interactions.

public String toString ()

Added in API level 23

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
  • a printable representation of this object.

public void writeToParcel (Parcel dest, int flags)

Added in API level 23

Flatten this object in to a Parcel.

Parameters
dest The Parcel in which the object should be written.
flags Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.