Option

Kotlin |Java

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.

Summary

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public constructors
`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.

Public methods
VoiceInteractor.PickOptionRequest.Option!	`addSynonym(synonym: CharSequence!)` Add a synonym term to the option to indicate an alternative way the content may be matched.
Int	`countSynonyms()`
Int	`describeContents()`
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(index: Int)`
Unit	`setExtras(extras: Bundle!)` Set optional extra information associated with this option.
Unit	`writeToParcel(dest: Parcel, flags: Int)`

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

Public constructors

Option

Added in API level 23

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

fun addSynonym(synonym: CharSequence!): VoiceInteractor.PickOptionRequest.Option!

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.

countSynonyms

Added in API level 23

fun countSynonyms(): Int

describeContents

Added in API level 23

fun describeContents(): Int

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`

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.

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.

getLabel

Added in API level 23

fun getLabel(): CharSequence!

getSynonymAt

Added in API level 23

fun getSynonymAt(index: Int): CharSequence!

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.

writeToParcel

Added in API level 23

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

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

Properties

CREATOR

Added in API level 23

static val CREATOR: Parcelable.Creator<VoiceInteractor.PickOptionRequest.Option!>