# SpellCheckerSession.SpellCheckerSessionParams

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Summary:[Nested Classes](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams#nestedclasses)\|[Methods](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams#inhmethods)  

# SpellCheckerSession.SpellCheckerSessionParams

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams "View this page in Kotlin")\|Java

`
public
static


class
SpellCheckerSession.SpellCheckerSessionParams
`  
`

extends `[Object](https://developer.android.com/reference/java/lang/Object)`


``


`

|---|------------------------------------------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.view.textservice.SpellCheckerSession.SpellCheckerSessionParams |

<br />

*** ** * ** ***

Parameters used to create a[SpellCheckerSession](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession).

## Summary

|                                                                                                                                                                ### Nested classes                                                                                                                                                                ||
|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` class` | [SpellCheckerSession.SpellCheckerSessionParams.Builder](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder) Builder of[SpellCheckerSessionParams](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams). |

|                                                                                                                                                                                                                                                         ### Public methods                                                                                                                                                                                                                                                          ||
|------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` `[Bundle](https://developer.android.com/reference/android/os/Bundle) | ` `[getExtras](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams#getExtras())`() ` Returns a bundle containing extra parameters for the spell checker.                                                                                                                                                                                                                                         |
| ` `[Locale](https://developer.android.com/reference/java/util/Locale)  | ` `[getLocale](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams#getLocale())`() ` Returns the locale in which the spell checker should operate.                                                                                                                                                                                                                                               |
| ` int`                                                                 | ` `[getSupportedAttributes](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams#getSupportedAttributes())`() ` Returns a bitmask of[SuggestionsInfo](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo)attributes that the spell checker can set in[SuggestionsInfo](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo)it returns. |
| ` boolean`                                                             | ` `[shouldReferToSpellCheckerLanguageSettings](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams#shouldReferToSpellCheckerLanguageSettings())`() ` Returns true if the user's spell checker language settings should be used to determine the spell checker locale.                                                                                                                            |

| ### 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*.                                                                                             | ||

## Public methods

### getExtras

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public Bundle getExtras ()
```

Returns a bundle containing extra parameters for the spell checker.

This bundle can be used to pass implementation-specific parameters to the[SpellCheckerService](https://developer.android.com/reference/android/service/textservice/SpellCheckerService)implementation.

<br />

|                                                 Returns                                                 ||
|---------------------------------------------------------------------|------------------------------------|
| [Bundle](https://developer.android.com/reference/android/os/Bundle) | This value cannot be`null`. <br /> |

**See also:**

- [SpellCheckerService.Session.getBundle()](https://developer.android.com/reference/android/service/textservice/SpellCheckerService.Session#getBundle())  

### getLocale

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public Locale getLocale ()
```

Returns the locale in which the spell checker should operate.

<br />

|                                               Returns                                               ||
|--------------------------------------------------------------------|---------------------------------|
| [Locale](https://developer.android.com/reference/java/util/Locale) | This value may be`null`. <br /> |

**See also:**

- [SpellCheckerService.Session.getLocale()](https://developer.android.com/reference/android/service/textservice/SpellCheckerService.Session#getLocale())  

### getSupportedAttributes

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public int getSupportedAttributes ()
```

Returns a bitmask of[SuggestionsInfo](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo)attributes that the spell checker can set in[SuggestionsInfo](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo)it returns.

<br />

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns                                                                                                                                                                                                                                                                                                                                                                                                                                                                   ||
|-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `int` | Value is either`0`or a combination of[SuggestionsInfo.RESULT_ATTR_IN_THE_DICTIONARY](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_IN_THE_DICTIONARY),[SuggestionsInfo.RESULT_ATTR_LOOKS_LIKE_TYPO](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_LOOKS_LIKE_TYPO),[SuggestionsInfo.RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS),[SuggestionsInfo.RESULT_ATTR_LOOKS_LIKE_GRAMMAR_ERROR](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_LOOKS_LIKE_GRAMMAR_ERROR), and[SuggestionsInfo.RESULT_ATTR_DONT_SHOW_UI_FOR_SUGGESTIONS](https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_DONT_SHOW_UI_FOR_SUGGESTIONS) <br /> |

**See also:**

- [SpellCheckerService.Session.getSupportedAttributes()](https://developer.android.com/reference/android/service/textservice/SpellCheckerService.Session#getSupportedAttributes())  

### shouldReferToSpellCheckerLanguageSettings

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public boolean shouldReferToSpellCheckerLanguageSettings ()
```

Returns true if the user's spell checker language settings should be used to determine the spell checker locale.

<br />

|      Returns      ||
|-----------|--------|
| `boolean` | <br /> |