SuggestionsInfo

Kotlin |Java

class SuggestionsInfo : Parcelable

kotlin.Any
↳	android.view.textservice.SuggestionsInfo

This class contains a metadata of suggestions from the text service

Summary

Constants
static Int	`RESULT_ATTR_DONT_SHOW_UI_FOR_SUGGESTIONS` Flag of the attributes of the suggestions that can be obtained by `getSuggestionsAttributes`: this tells that the text service has an alternative way to show UI for the list of correction suggestions to the user.
static Int	`RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS` Flag of the attributes of the suggestions that can be obtained by `getSuggestionsAttributes`: this tells that the text service thinks the result suggestions include highly recommended ones.
static Int	`RESULT_ATTR_IN_THE_DICTIONARY` Flag of the attributes of the suggestions that can be obtained by `getSuggestionsAttributes`: this tells that the requested word was found in the dictionary in the text service.
static Int	`RESULT_ATTR_LOOKS_LIKE_GRAMMAR_ERROR` Flag of the attributes of the suggestions that can be obtained by `getSuggestionsAttributes`: this tells that the text service thinks the requested sentence contains a grammar error.
static Int	`RESULT_ATTR_LOOKS_LIKE_TYPO` Flag of the attributes of the suggestions that can be obtained by `getSuggestionsAttributes`: this tells that the text service thinks the requested word looks like a typo.

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
`SuggestionsInfo(source: Parcel!)`
`SuggestionsInfo(suggestionsAttributes: Int, suggestions: Array<String!>!)` Constructor.
`SuggestionsInfo(suggestionsAttributes: Int, suggestions: Array<String!>!, cookie: Int, sequence: Int)` Constructor.

Public methods
Int	`describeContents()` Used to make this class parcelable.
Int	`getCookie()`
Int	`getSequence()`
String!	`getSuggestionAt(i: Int)`
Int	`getSuggestionsAttributes()`
Int	`getSuggestionsCount()`
Unit	`setCookieAndSequence(cookie: Int, sequence: Int)` Set the cookie and the sequence of SuggestionsInfo which are set to TextInfo from a client application
Unit	`writeToParcel(dest: Parcel, flags: Int)` Used to package this object into a `Parcel`.

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

Constants

RESULT_ATTR_DONT_SHOW_UI_FOR_SUGGESTIONS

Added in API level 31

static val RESULT_ATTR_DONT_SHOW_UI_FOR_SUGGESTIONS: Int

Flag of the attributes of the suggestions that can be obtained by getSuggestionsAttributes: this tells that the text service has an alternative way to show UI for the list of correction suggestions to the user. When this flag is set, the receiver of the result suggestions should mark the erroneous part of the text with a text signifier (for example, underline), but should not show any UI for the list of correction suggestions to the user (for example, in a popup window).

Value: 16

RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS

Added in API level 15

static val RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS: Int

Flag of the attributes of the suggestions that can be obtained by getSuggestionsAttributes: this tells that the text service thinks the result suggestions include highly recommended ones.

Value: 4

RESULT_ATTR_IN_THE_DICTIONARY

Added in API level 14

static val RESULT_ATTR_IN_THE_DICTIONARY: Int

Flag of the attributes of the suggestions that can be obtained by getSuggestionsAttributes: this tells that the requested word was found in the dictionary in the text service.

Value: 1

RESULT_ATTR_LOOKS_LIKE_GRAMMAR_ERROR

Added in API level 31

static val RESULT_ATTR_LOOKS_LIKE_GRAMMAR_ERROR: Int

Flag of the attributes of the suggestions that can be obtained by getSuggestionsAttributes: this tells that the text service thinks the requested sentence contains a grammar error.

Value: 8

RESULT_ATTR_LOOKS_LIKE_TYPO

Added in API level 14

static val RESULT_ATTR_LOOKS_LIKE_TYPO: Int

Flag of the attributes of the suggestions that can be obtained by getSuggestionsAttributes: this tells that the text service thinks the requested word looks like a typo.

Value: 2

Public constructors

SuggestionsInfo

Added in API level 14

SuggestionsInfo(source: Parcel!)

SuggestionsInfo

Added in API level 14

SuggestionsInfo(
    suggestionsAttributes: Int, 
    suggestions: Array<String!>!)

Constructor.

Parameters
`suggestionsAttributes`	Int: from the text service
`suggestions`	Array<String!>!: from the text service

SuggestionsInfo

Added in API level 14

SuggestionsInfo(
    suggestionsAttributes: Int, 
    suggestions: Array<String!>!, 
    cookie: Int, 
    sequence: Int)

Constructor.

Parameters
`suggestionsAttributes`	Int: from the text service Value is either `0` or a combination of `android.view.textservice.SuggestionsInfo#RESULT_ATTR_IN_THE_DICTIONARY`, `android.view.textservice.SuggestionsInfo#RESULT_ATTR_LOOKS_LIKE_TYPO`, `android.view.textservice.SuggestionsInfo#RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS`, `android.view.textservice.SuggestionsInfo#RESULT_ATTR_LOOKS_LIKE_GRAMMAR_ERROR`, and `android.view.textservice.SuggestionsInfo#RESULT_ATTR_DONT_SHOW_UI_FOR_SUGGESTIONS`
`suggestions`	Array<String!>!: from the text service
`cookie`	Int: the cookie of the input TextInfo
`sequence`	Int: the cookie of the input TextInfo

Public methods

describeContents

Added in API level 14

fun describeContents(): Int

Used to make this class parcelable.

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`

getCookie

Added in API level 14

fun getCookie(): Int

Return
`Int`	the cookie which may be set by a client application

getSequence

Added in API level 14

fun getSequence(): Int

Return
`Int`	the sequence which may be set by a client application

getSuggestionAt

Added in API level 14

fun getSuggestionAt(i: Int): String!

Parameters
`i`	Int: the id of suggestions

Return
`String!`	the suggestion at the specified id

getSuggestionsAttributes

Added in API level 14

fun getSuggestionsAttributes(): Int

Return

Int the attributes of suggestions. This includes whether the spell checker has the word in its dictionary or not and whether the spell checker has confident suggestions for the word or not. Value is either 0 or a combination of android.view.textservice.SuggestionsInfo#RESULT_ATTR_IN_THE_DICTIONARY, android.view.textservice.SuggestionsInfo#RESULT_ATTR_LOOKS_LIKE_TYPO, android.view.textservice.SuggestionsInfo#RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS, android.view.textservice.SuggestionsInfo#RESULT_ATTR_LOOKS_LIKE_GRAMMAR_ERROR, and android.view.textservice.SuggestionsInfo#RESULT_ATTR_DONT_SHOW_UI_FOR_SUGGESTIONS

Return
`Int`	the attributes of suggestions. This includes whether the spell checker has the word in its dictionary or not and whether the spell checker has confident suggestions for the word or not. Value is either `0` or a combination of `android.view.textservice.SuggestionsInfo#RESULT_ATTR_IN_THE_DICTIONARY`, `android.view.textservice.SuggestionsInfo#RESULT_ATTR_LOOKS_LIKE_TYPO`, `android.view.textservice.SuggestionsInfo#RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS`, `android.view.textservice.SuggestionsInfo#RESULT_ATTR_LOOKS_LIKE_GRAMMAR_ERROR`, and `android.view.textservice.SuggestionsInfo#RESULT_ATTR_DONT_SHOW_UI_FOR_SUGGESTIONS`

getSuggestionsCount

Added in API level 14

fun getSuggestionsCount(): Int

Return
`Int`	the count of the suggestions. If there's no suggestions at all, this method returns -1. Even if this method returns 0, it doesn't necessarily mean that there are no suggestions for the requested word. For instance, the caller could have been asked to limit the maximum number of suggestions returned.

setCookieAndSequence

Added in API level 14

fun setCookieAndSequence(
    cookie: Int, 
    sequence: Int
): Unit

Set the cookie and the sequence of SuggestionsInfo which are set to TextInfo from a client application

Parameters
`cookie`	Int: the cookie of an input TextInfo
`sequence`	Int: the cookie of an input TextInfo

writeToParcel

Added in API level 14

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 14

static val CREATOR: Parcelable.Creator<SuggestionsInfo!>

Used to make this class parcelable.