public
static
class
VoiceInteractor.Prompt
extends Object
implements
Parcelable
| java.lang.Object | |
| ↳ | android.app.VoiceInteractor.Prompt |
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".
Inherited constants |
|---|
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. |
Inherited methods | |
|---|---|
java.lang.Object
| |
android.os.Parcelable
| |
VoiceInteractor.Prompt (CharSequence[] voicePrompts, CharSequence visualPrompt)
Constructs a prompt set.
| Parameters | |
|---|---|
voicePrompts |
CharSequence:
An array of one or more voice prompts. Must not be empty or null. |
visualPrompt |
CharSequence:
A prompt to display on the screen. Must not be null.
|
VoiceInteractor.Prompt (CharSequence prompt)
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.
| Parameters | |
|---|---|
prompt |
CharSequence
|
int countVoicePrompts ()
Returns the number of different voice prompts.
| Returns | |
|---|---|
int |
|
int describeContents ()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
| Returns | |
|---|---|
int |
a bitmask indicating the set of special object types marshalled by the Parcelable. |
CharSequence getVisualPrompt ()
Returns the prompt to use for visual display.
| Returns | |
|---|---|
CharSequence |
|
CharSequence getVoicePromptAt (int index)
Returns a prompt to use for voice interactions.
| Parameters | |
|---|---|
index |
int
|
| Returns | |
|---|---|
CharSequence |
|
String toString ()
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 | |
|---|---|
String |
a printable representation of this object. |
void writeToParcel (Parcel dest, int flags)
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
dest |
Parcel:
The Parcel in which the object should be written. |
flags |
int:
Additional flags about how the object should be written.
May be 0 or PARCELABLE_WRITE_RETURN_VALUE.
|