Added in API level 23

Summary: Inherited Constants | Fields | Ctors | Methods | Inherited Methods

VoiceInteractor.Prompt

Kotlin |Java

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

Summary

Inherited constants

From interface android.os.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(Parcel, int)`: 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)`".

Fields
`public static final Creator<VoiceInteractor.Prompt>`	`CREATOR`

Public constructors
`Prompt(CharSequence prompt)` Constructs a prompt set with single prompt used for all interactions.
`Prompt(CharSequence[] voicePrompts, CharSequence visualPrompt)` Constructs a prompt set.

Public methods
`int`	`countVoicePrompts()` Returns the number of different voice prompts.
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled 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 representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 23

public static final Creator<VoiceInteractor.Prompt> CREATOR

Public constructors

Prompt

Added in API level 23

public 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`: This value cannot be `null`.

Prompt

Added in API level 23

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

Public methods

countVoicePrompts

Added in API level 23

public int countVoicePrompts ()

Returns the number of different voice prompts.

Returns
`int`

describeContents

Added in API level 23

public int describeContents ()

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.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getVisualPrompt

Added in API level 23

public CharSequence getVisualPrompt ()

Returns the prompt to use for visual display.

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

getVoicePromptAt

Added in API level 23

public CharSequence getVoicePromptAt (int index)

Returns a prompt to use for voice interactions.

Parameters
`index`	`int`

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

toString

Added in API level 23

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 23

public 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. This value cannot be `null`.
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES