# SuggestionsInfo
Added in[API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
Summary:[Constants](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#constants)\|[Inherited Constants](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#inhconstants)\|[Fields](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#lfields)\|[Ctors](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#pubctors)\|[Methods](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#inhmethods)
# SuggestionsInfo
*** ** * ** ***
[Kotlin](https://developer.android.com/reference/kotlin/android/view/textservice/SuggestionsInfo "View this page in Kotlin")\|Java
`
public
final
class
SuggestionsInfo
`
`
extends `[Object](https://developer.android.com/reference/java/lang/Object)`
``
implements
`[Parcelable](https://developer.android.com/reference/android/os/Parcelable)`
`
|---|------------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.view.textservice.SuggestionsInfo |
*** ** * ** ***
This class contains a metadata of suggestions from the text service
## Summary
| ### Constants ||
|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `int` | [RESULT_ATTR_DONT_SHOW_UI_FOR_SUGGESTIONS](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_DONT_SHOW_UI_FOR_SUGGESTIONS) Flag of the attributes of the suggestions that can be obtained by[getSuggestionsAttributes()](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#getSuggestionsAttributes()): this tells that the text service has an alternative way to show UI for the list of correction suggestions to the user. |
| `int` | [RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS) Flag of the attributes of the suggestions that can be obtained by[getSuggestionsAttributes()](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#getSuggestionsAttributes()): this tells that the text service thinks the result suggestions include highly recommended ones. |
| `int` | [RESULT_ATTR_IN_THE_DICTIONARY](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_IN_THE_DICTIONARY) Flag of the attributes of the suggestions that can be obtained by[getSuggestionsAttributes()](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#getSuggestionsAttributes()): this tells that the requested word was found in the dictionary in the text service. |
| `int` | [RESULT_ATTR_LOOKS_LIKE_GRAMMAR_ERROR](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_LOOKS_LIKE_GRAMMAR_ERROR) Flag of the attributes of the suggestions that can be obtained by[getSuggestionsAttributes()](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#getSuggestionsAttributes()): this tells that the text service thinks the requested sentence contains a grammar error. |
| `int` | [RESULT_ATTR_LOOKS_LIKE_TYPO](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_LOOKS_LIKE_TYPO) Flag of the attributes of the suggestions that can be obtained by[getSuggestionsAttributes()](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#getSuggestionsAttributes()): this tells that the text service thinks the requested word looks like a typo. |
| ### Inherited constants |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From interface[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable) |-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR) Descriptor bit used with[describeContents()](https://developer.android.com/reference/android/os/Parcelable#describeContents()): indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | [PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE) Flag for use with[writeToParcel(Parcel, int)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)): 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](https://developer.android.com/reference/android/os/Parcelable.Creator)`<`[SuggestionsInfo](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo)`>` | [CREATOR](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#CREATOR) Used to make this class parcelable. |
| ### Public constructors ||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[SuggestionsInfo](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#SuggestionsInfo(android.os.Parcel))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` source) ` |
| ` `[SuggestionsInfo](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#SuggestionsInfo(int,%20java.lang.String[]))`(int suggestionsAttributes, `[String[]](https://developer.android.com/reference/java/lang/String)` suggestions) ` Constructor. |
| ` `[SuggestionsInfo](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#SuggestionsInfo(int,%20java.lang.String[],%20int,%20int))`(int suggestionsAttributes, `[String[]](https://developer.android.com/reference/java/lang/String)` suggestions, int cookie, int sequence) ` Constructor. |
| ### Public methods ||
|-----------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` int` | ` `[describeContents](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#describeContents())`() ` Used to make this class parcelable. |
| ` int` | ` `[getCookie](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#getCookie())`() ` |
| ` int` | ` `[getSequence](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#getSequence())`() ` |
| ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[getSuggestionAt](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#getSuggestionAt(int))`(int i) ` |
| ` int` | ` `[getSuggestionsAttributes](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#getSuggestionsAttributes())`() ` |
| ` int` | ` `[getSuggestionsCount](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#getSuggestionsCount())`() ` |
| ` void` | ` `[setCookieAndSequence](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#setCookieAndSequence(int,%20int))`(int cookie, int sequence) ` Set the cookie and the sequence of SuggestionsInfo which are set to TextInfo from a client application |
| ` void` | ` `[writeToParcel](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Used to package this object into a[Parcel](https://developer.android.com/reference/android/os/Parcel). |
| ### Inherited methods |
|-----------------------|---|
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object) | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`. | | ` int` | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(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](https://developer.android.com/reference/java/lang/Object#wait(long))`(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](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*. | ||
| From interface` `[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable)` ` |------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract int` | ` `[describeContents](https://developer.android.com/reference/android/os/Parcelable#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. | | ` abstract void` | ` `[writeToParcel](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel. | ||
## Constants
### RESULT_ATTR_DONT_SHOW_UI_FOR_SUGGESTIONS
Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int RESULT_ATTR_DONT_SHOW_UI_FOR_SUGGESTIONS
```
Flag of the attributes of the suggestions that can be obtained by[getSuggestionsAttributes()](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#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).
Constant Value: 16 (0x00000010)
### RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS
Added in[API level 15](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS
```
Flag of the attributes of the suggestions that can be obtained by[getSuggestionsAttributes()](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#getSuggestionsAttributes()): this tells that the text service thinks the result suggestions include highly recommended ones.
Constant Value: 4 (0x00000004)
### RESULT_ATTR_IN_THE_DICTIONARY
Added in[API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int RESULT_ATTR_IN_THE_DICTIONARY
```
Flag of the attributes of the suggestions that can be obtained by[getSuggestionsAttributes()](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#getSuggestionsAttributes()): this tells that the requested word was found in the dictionary in the text service.
Constant Value: 1 (0x00000001)
### RESULT_ATTR_LOOKS_LIKE_GRAMMAR_ERROR
Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int RESULT_ATTR_LOOKS_LIKE_GRAMMAR_ERROR
```
Flag of the attributes of the suggestions that can be obtained by[getSuggestionsAttributes()](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#getSuggestionsAttributes()): this tells that the text service thinks the requested sentence contains a grammar error.
Constant Value: 8 (0x00000008)
### RESULT_ATTR_LOOKS_LIKE_TYPO
Added in[API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int RESULT_ATTR_LOOKS_LIKE_TYPO
```
Flag of the attributes of the suggestions that can be obtained by[getSuggestionsAttributes()](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#getSuggestionsAttributes()): this tells that the text service thinks the requested word looks like a typo.
Constant Value: 2 (0x00000002)
## Fields
### CREATOR
Added in[API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final Creator CREATOR
```
Used to make this class parcelable.
## Public constructors
### SuggestionsInfo
Added in[API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public SuggestionsInfo (Parcel source)
```
| Parameters ||
|----------|-----------------|
| `source` | `Parcel`
|
### SuggestionsInfo
Added in[API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public SuggestionsInfo (int suggestionsAttributes,
String[] suggestions)
```
Constructor.
| Parameters ||
|-------------------------|----------------------------------------|
| `suggestionsAttributes` | `int`: from the text service
|
| `suggestions` | `String`: from the text service
|
### SuggestionsInfo
Added in[API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public SuggestionsInfo (int suggestionsAttributes,
String[] suggestions,
int cookie,
int sequence)
```
Constructor.
| Parameters ||
|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `suggestionsAttributes` | `int`: from the text service Value is either`0`or a combination of[RESULT_ATTR_IN_THE_DICTIONARY](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_IN_THE_DICTIONARY),[RESULT_ATTR_LOOKS_LIKE_TYPO](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_LOOKS_LIKE_TYPO),[RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS),[RESULT_ATTR_LOOKS_LIKE_GRAMMAR_ERROR](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_LOOKS_LIKE_GRAMMAR_ERROR), and[RESULT_ATTR_DONT_SHOW_UI_FOR_SUGGESTIONS](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_DONT_SHOW_UI_FOR_SUGGESTIONS)
|
| `suggestions` | `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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int describeContents ()
```
Used to make this class parcelable.
| 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](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR)
|
### getCookie
Added in[API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getCookie ()
```
| Returns ||
|-------|------------------------------------------------------------|
| `int` | the cookie which may be set by a client application
|
### getSequence
Added in[API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getSequence ()
```
| Returns ||
|-------|--------------------------------------------------------------|
| `int` | the sequence which may be set by a client application
|
### getSuggestionAt
Added in[API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String getSuggestionAt (int i)
```
| Parameters ||
|-----|-------------------------------------|
| `i` | `int`: the id of suggestions
|
| Returns ||
|--------------------------------------------------------------------|-------------------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | the suggestion at the specified id
|
### getSuggestionsAttributes
Added in[API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getSuggestionsAttributes ()
```
| Returns ||
|-------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `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[RESULT_ATTR_IN_THE_DICTIONARY](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_IN_THE_DICTIONARY),[RESULT_ATTR_LOOKS_LIKE_TYPO](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_LOOKS_LIKE_TYPO),[RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS),[RESULT_ATTR_LOOKS_LIKE_GRAMMAR_ERROR](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_LOOKS_LIKE_GRAMMAR_ERROR), and[RESULT_ATTR_DONT_SHOW_UI_FOR_SUGGESTIONS](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_DONT_SHOW_UI_FOR_SUGGESTIONS)
|
### getSuggestionsCount
Added in[API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getSuggestionsCount ()
```
| Returns ||
|-------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void setCookieAndSequence (int cookie,
int sequence)
```
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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void writeToParcel (Parcel dest,
int flags)
```
Used to package this object into a[Parcel](https://developer.android.com/reference/android/os/Parcel).
| Parameters ||
|---------|-------------------------------------------------------------------------------------------------------|
| `dest` | `Parcel`: The[Parcel](https://developer.android.com/reference/android/os/Parcel)to be written.
|
| `flags` | `int`: The flags used for parceling.
|