lightbulb_outline Please take our October 2018 developer survey. Start survey

VoiceInteractor.PickOptionRequest.Option

public static final class VoiceInteractor.PickOptionRequest.Option
extends Object implements Parcelable

java.lang.Object
   ↳ android.app.VoiceInteractor.PickOptionRequest.Option


Represents a single option that the user may select using their voice. The getIndex() method should be used as a unique ID to identify the option when it is returned from the voice interactor.

Summary

Inherited constants

Fields

public static final Creator<VoiceInteractor.PickOptionRequest.Option> CREATOR

Public constructors

VoiceInteractor.PickOptionRequest.Option(CharSequence label, int index)

Creates an option that a user can select with their voice by matching the label or one of several synonyms.

Public methods

VoiceInteractor.PickOptionRequest.Option addSynonym(CharSequence synonym)

Add a synonym term to the option to indicate an alternative way the content may be matched.

int countSynonyms()
int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

Bundle getExtras()

Return any optional extras information associated with this option, or null if there is none.

int getIndex()

Return the index that was supplied in the constructor.

CharSequence getLabel()
CharSequence getSynonymAt(int index)
void setExtras(Bundle extras)

Set optional extra information associated with this option.

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.PickOptionRequest.Option> CREATOR

Public constructors

VoiceInteractor.PickOptionRequest.Option

added in API level 23
public VoiceInteractor.PickOptionRequest.Option (CharSequence label, 
                int index)

Creates an option that a user can select with their voice by matching the label or one of several synonyms.

Parameters
label CharSequence: The label that will both be matched against what the user speaks and displayed visually.

index int: The location of this option within the overall set of options. Can be used to help identify the option when it is returned from the voice interactor.

Public methods

addSynonym

added in API level 23
public VoiceInteractor.PickOptionRequest.Option addSynonym (CharSequence synonym)

Add a synonym term to the option to indicate an alternative way the content may be matched.

Parameters
synonym CharSequence: The synonym that will be matched against what the user speaks, but not displayed.

Returns
VoiceInteractor.PickOptionRequest.Option

countSynonyms

added in API level 23
public int countSynonyms ()

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.

getExtras

added in API level 23
public Bundle getExtras ()

Return any optional extras information associated with this option, or null if there is none. Note that this method returns a reference to the actual extras Bundle in the option, so modifications to it will directly modify the extras in the option.

Returns
Bundle

getIndex

added in API level 23
public int getIndex ()

Return the index that was supplied in the constructor. If the option was constructed without an index, -1 is returned.

Returns
int

getLabel

added in API level 23
public CharSequence getLabel ()

Returns
CharSequence

getSynonymAt

added in API level 23
public CharSequence getSynonymAt (int index)

Parameters
index int

Returns
CharSequence

setExtras

added in API level 23
public void setExtras (Bundle extras)

Set optional extra information associated with this option. Note that this method takes ownership of the supplied extras Bundle.

Parameters
extras Bundle

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.