Option

class Option : Parcelable
kotlin.Any
   ↳ 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.
Requires API level 23 (Android 6.0, Marshmallow)

Summary

Inherited constants
Public constructors
<init>(label: CharSequence!, index: Int)

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

Public methods
CharSequence!

Requires API level 23 (Android 6.0, Marshmallow)

Int

Return the index that was supplied in the constructor.

Bundle!

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

Unit
setExtras(extras: Bundle!)

Set optional extra information associated with this option.

VoiceInteractor.PickOptionRequest.Option!

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

Unit
writeToParcel(dest: Parcel!, flags: Int)

Flatten this object in to a Parcel.

Int

Requires API level 23 (Android 6.0, Marshmallow)

CharSequence!
getSynonymAt(index: Int)

Requires API level 23 (Android 6.0, Marshmallow)

Int

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

Properties
static Parcelable.Creator<VoiceInteractor.PickOptionRequest.Option!>!

Requires API level 23 (Android 6.0, Marshmallow)

Public constructors

<init>

Option(label: CharSequence!, index: Int)

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 CharSequence!: 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

getLabel

added in API level 23
fun getLabel(): CharSequence!

Requires API level 23 (Android 6.0, Marshmallow)

getIndex

added in API level 23
fun getIndex(): Int

Return the index that was supplied in the constructor. If the option was constructed without an index, -1 is returned.
Requires API level 23 (Android 6.0, Marshmallow)

getExtras

added in API level 23
fun getExtras(): Bundle!

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.
Requires API level 23 (Android 6.0, Marshmallow)

setExtras

added in API level 23
fun setExtras(extras: Bundle!): Unit

Set optional extra information associated with this option. Note that this method takes ownership of the supplied extras Bundle.
Requires API level 23 (Android 6.0, Marshmallow)

addSynonym

added in API level 23
fun addSynonym(synonym: CharSequence!): VoiceInteractor.PickOptionRequest.Option!

Add a synonym term to the option to indicate an alternative way the content may be matched.
Requires API level 23 (Android 6.0, Marshmallow)

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

writeToParcel

added in API level 23
fun writeToParcel(dest: Parcel!, flags: Int): Unit

Flatten this object in to a Parcel. Requires API level 23 (Android 6.0, Marshmallow)

Parameters
dest Parcel!: The Parcel in which the object should be written.
flags Parcel!: 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

countSynonyms

added in API level 23
fun countSynonyms(): Int

Requires API level 23 (Android 6.0, Marshmallow)

getSynonymAt

added in API level 23
fun getSynonymAt(index: Int): CharSequence!

Requires API level 23 (Android 6.0, Marshmallow)

describeContents

added in API level 23
fun describeContents(): Int

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. Requires API level 23 (Android 6.0, Marshmallow)

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

Properties

CREATOR

added in API level 23
static val CREATOR: Parcelable.Creator<VoiceInteractor.PickOptionRequest.Option!>!

Requires API level 23 (Android 6.0, Marshmallow)