Prompt

Kotlin |Java

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

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

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	`countVoicePrompts()` Returns the number of different voice prompts.
open Int	`describeContents()`
open CharSequence	`getVisualPrompt()` Returns the prompt to use for visual display.
open CharSequence	`getVoicePromptAt(index: Int)` Returns a prompt to use for voice interactions.
open String	`toString()`
open Unit	`writeToParcel(dest: Parcel, flags: Int)`

Properties
static Parcelable.Creator<VoiceInteractor.Prompt!>	`CREATOR`

Public constructors

Prompt

Added in API level 23

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

Added in API level 23

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

Added in API level 23

open fun countVoicePrompts(): Int

Returns the number of different voice prompts.

describeContents

Added in API level 23

open fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

getVisualPrompt

Added in API level 23

open fun getVisualPrompt(): CharSequence

Returns the prompt to use for visual display.

Return
`CharSequence`	This value cannot be `null`.

getVoicePromptAt

Added in API level 23

open fun getVoicePromptAt(index: Int): CharSequence

Returns a prompt to use for voice interactions.

Return
`CharSequence`	This value cannot be `null`.

toString

Added in API level 23

open fun toString(): String

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 23

open fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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 `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 23

static val CREATOR: Parcelable.Creator<VoiceInteractor.Prompt!>