Added in API level 23

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

VoiceInteractor.PickOptionRequest.Option

---

Kotlin |Java

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

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

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

Public constructors

Option

Added in API level 23

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

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