SentenceSuggestionsInfo

Kotlin |Java

class SentenceSuggestionsInfo : Parcelable

kotlin.Any
↳	android.view.textservice.SentenceSuggestionsInfo

This class contains a metadata of suggestions returned from a text service (e.g. android.service.textservice.SpellCheckerService). The text service uses this class to return the suggestions for a sentence. See SuggestionsInfo which is used for suggestions for a word. This class extends the functionality of SuggestionsInfo as far as this class enables you to put multiple SuggestionsInfos on a sentence with the offsets and the lengths of all SuggestionsInfos.

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
`SentenceSuggestionsInfo(source: Parcel!)`
`SentenceSuggestionsInfo(suggestionsInfos: Array<SuggestionsInfo!>!, offsets: IntArray!, lengths: IntArray!)` Constructor.

Public methods
Int	`describeContents()`
Int	`getLengthAt(i: Int)`
Int	`getOffsetAt(i: Int)`
Int	`getSuggestionsCount()`
SuggestionsInfo!	`getSuggestionsInfoAt(i: Int)`
Unit	`writeToParcel(dest: Parcel, flags: Int)` Used to package this object into a `Parcel`.

Properties
static Parcelable.Creator<SentenceSuggestionsInfo!>	`CREATOR` Used to make this class parcelable.

Public constructors

SentenceSuggestionsInfo

Added in API level 16

SentenceSuggestionsInfo(source: Parcel!)

SentenceSuggestionsInfo

Added in API level 16

SentenceSuggestionsInfo(
    suggestionsInfos: Array<SuggestionsInfo!>!, 
    offsets: IntArray!, 
    lengths: IntArray!)

Constructor.

Parameters
`suggestionsInfos`	Array<SuggestionsInfo!>!: from the text service
`offsets`	IntArray!: the array of offsets of suggestions
`lengths`	IntArray!: the array of lengths of suggestions

Public methods

describeContents

Added in API level 16

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`

getLengthAt

Added in API level 16

fun getLengthAt(i: Int): Int

Parameters
`i`	Int: the id of `SuggestionsInfo`s this instance holds

Return
`Int`	the length of the specified `SuggestionsInfo`

getOffsetAt

Added in API level 16

fun getOffsetAt(i: Int): Int

Parameters
`i`	Int: the id of `SuggestionsInfo`s this instance holds

Return
`Int`	the offset of the specified `SuggestionsInfo`

getSuggestionsCount

Added in API level 16

fun getSuggestionsCount(): Int

Return
`Int`	the count of `SuggestionsInfo`s this instance holds.

getSuggestionsInfoAt

Added in API level 16

fun getSuggestionsInfoAt(i: Int): SuggestionsInfo!

Parameters
`i`	Int: the id of `SuggestionsInfo`s this instance holds.

Return
`SuggestionsInfo!`	a `SuggestionsInfo` at the specified id

writeToParcel

Added in API level 16

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

Used to package this object into a Parcel.

Parameters
`dest`	Parcel: The `Parcel` to be written.
`flags`	Int: The flags used for parceling.

Properties

CREATOR

Added in API level 16

static val CREATOR: Parcelable.Creator<SentenceSuggestionsInfo!>

Used to make this class parcelable.