Prompt
class Prompt : Parcelable
| kotlin.Any | |
| ↳ | 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".
Summary
| Inherited constants | |
|---|---|
| Public constructors | |
|---|---|
Prompt(prompt: CharSequence)Constructs a prompt set with single prompt used for all interactions. |
|
Prompt(voicePrompts: Array<CharSequence!>, visualPrompt: CharSequence)Constructs a prompt set. |
|
| Public methods | |
|---|---|
| open Int |
Returns the number of different voice prompts. |
| open Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| open CharSequence |
Returns the prompt to use for visual display. |
| open CharSequence |
getVoicePromptAt(index: Int)Returns a prompt to use for voice interactions. |
| open String |
toString()Returns a string representation of the object. |
| open Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<VoiceInteractor.Prompt!> | |
Public constructors
Prompt
Prompt(prompt: CharSequence)
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: This value cannot be null. |
Prompt
Prompt(
voicePrompts: Array<CharSequence!>,
visualPrompt: CharSequence)
Constructs a prompt set.
| Parameters | |
|---|---|
voicePrompts |
Array<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. |
Public methods
countVoicePrompts
open fun countVoicePrompts(): Int
Returns the number of different voice prompts.
describeContents
open fun describeContents(): Int
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
getVisualPrompt
open fun getVisualPrompt(): CharSequence
Returns the prompt to use for visual display.
| Return | |
|---|---|
CharSequence |
This value cannot be null. |
getVoicePromptAt
open fun getVoicePromptAt(index: Int): CharSequence
Returns a prompt to use for voice interactions.
| Return | |
|---|---|
CharSequence |
This value cannot be null. |
toString
open fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
open fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
dest |
Parcel: The Parcel in which the object should be written. This value cannot be null. |
flags |
Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following:
|