lightbulb_outline Please take our October 2018 developer survey. Start survey

VoiceInteractor.Prompt

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

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

Fields

CREATOR

added in API level 23
public static final Creator<VoiceInteractor.Prompt> CREATOR

Public constructors

VoiceInteractor.Prompt

added in API level 23
public 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

added in API level 23
public 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

This value must never 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(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.

getVisualPrompt

added in API level 23
public CharSequence getVisualPrompt ()

Returns the prompt to use for visual display.

Returns
CharSequence

This value will never 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 will never be null.

toString

added in API level 23
public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

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

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.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.