# SpellCheckerSession.SpellCheckerSessionParams.Builder Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) # Builder *** ** * ** *** Kotlin \|[Java](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder "View this page in Java") ``` class Builder ``` |---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) || | ↳ | [android.view.textservice.SpellCheckerSession.SpellCheckerSessionParams.Builder](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#) | Builder of [SpellCheckerSessionParams](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams). ## Summary | Public constructors || |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---| | [Builder](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#Builder())`()` Constructs a `Builder`. | | Public methods || |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [SpellCheckerSession.SpellCheckerSessionParams](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams) | [build](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#build())`()` Returns constructed [SpellCheckerSession](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession) instance. | | [SpellCheckerSession.SpellCheckerSessionParams.Builder](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#) | [setExtras](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#setExtras(android.os.Bundle))`(`extras:` `[Bundle](https://developer.android.com/reference/kotlin/android/os/Bundle.html#)`)` Sets a bundle containing extra parameters for the spell checker. | | [SpellCheckerSession.SpellCheckerSessionParams.Builder](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#) | [setLocale](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#setLocale(java.util.Locale))`(`locale:` `[Locale](https://developer.android.com/reference/kotlin/java/util/Locale.html#)?`)` Sets the locale in which the spell checker should operate. | | [SpellCheckerSession.SpellCheckerSessionParams.Builder](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#) | [setShouldReferToSpellCheckerLanguageSettings](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#setShouldReferToSpellCheckerLanguageSettings(kotlin.Boolean))`(`shouldReferToSpellCheckerLanguageSettings:` `[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` Sets whether or not the user's spell checker language settings should be used to determine spell checker locale. | | [SpellCheckerSession.SpellCheckerSessionParams.Builder](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#) | [setSupportedAttributes](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#setSupportedAttributes(kotlin.Int))`(`supportedAttributes:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Sets a bitmask of [SuggestionsInfo](https://developer.android.com/reference/kotlin/android/view/textservice/SuggestionsInfo) attributes that the spell checker can set in [SuggestionsInfo](https://developer.android.com/reference/kotlin/android/view/textservice/SuggestionsInfo) it returns. | ## Public constructors ### Builder Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` Builder() ``` Constructs a `Builder`. ## Public methods ### build Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun build(): SpellCheckerSession.SpellCheckerSessionParams ``` Returns constructed [SpellCheckerSession](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession) instance. Before calling this method, either [setLocale(java.util.Locale)](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#setLocale(java.util.Locale)) should be called with a non-null locale or [setShouldReferToSpellCheckerLanguageSettings(boolean)](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#setShouldReferToSpellCheckerLanguageSettings(kotlin.Boolean)) should be called with `true`. ### setExtras Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setExtras(extras: Bundle): SpellCheckerSession.SpellCheckerSessionParams.Builder ``` Sets a bundle containing extra parameters for the spell checker. This bundle can be used to pass implementation-specific parameters to the [android.service.textservice.SpellCheckerService](https://developer.android.com/reference/kotlin/android/service/textservice/SpellCheckerService.html#) implementation. | Parameters || |----------|----------------------------------------------------------------------------------------------------------------| | `extras` | [Bundle](https://developer.android.com/reference/kotlin/android/os/Bundle.html#): This value cannot be `null`. | | Return || |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| | [SpellCheckerSession.SpellCheckerSessionParams.Builder](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#) | This value cannot be `null`. | **See Also** - [android.service.textservice.SpellCheckerService.Session#getBundle()](https://developer.android.com/reference/kotlin/android/service/textservice/SpellCheckerService.Session.html#getBundle()) ### setLocale Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setLocale(locale: Locale?): SpellCheckerSession.SpellCheckerSessionParams.Builder ``` Sets the locale in which the spell checker should operate. | Parameters || |----------|-------------------------------------------------------------------------------------------------------------| | `locale` | [Locale](https://developer.android.com/reference/kotlin/java/util/Locale.html#)?: This value may be `null`. | | Return || |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| | [SpellCheckerSession.SpellCheckerSessionParams.Builder](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#) | This value cannot be `null`. | **See Also** - [android.service.textservice.SpellCheckerService.Session#getLocale()](https://developer.android.com/reference/kotlin/android/service/textservice/SpellCheckerService.Session.html#getLocale()) ### setShouldReferToSpellCheckerLanguageSettings Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setShouldReferToSpellCheckerLanguageSettings(shouldReferToSpellCheckerLanguageSettings: Boolean): SpellCheckerSession.SpellCheckerSessionParams.Builder ``` Sets whether or not the user's spell checker language settings should be used to determine spell checker locale. If `shouldReferToSpellCheckerLanguageSettings` is true, the exact way of determining spell checker locale differs based on `locale` specified in [setLocale(java.util.Locale)](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#setLocale(java.util.Locale)). If `shouldReferToSpellCheckerLanguageSettings` is true and `locale` is null, the locale specified in Settings will be used. If `shouldReferToSpellCheckerLanguageSettings` is true and `locale` is not null, [SpellCheckerSession](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession) can be created only when the locale specified in Settings is the same as `locale`. Exceptionally, if `shouldReferToSpellCheckerLanguageSettings` is true and `locale` is language only (e.g. "en"), the specified locale in Settings (e.g. "en_US") will be used. **See Also** - [#setLocale(Locale)](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#setLocale(java.util.Locale)) ### setSupportedAttributes Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setSupportedAttributes(supportedAttributes: Int): SpellCheckerSession.SpellCheckerSessionParams.Builder ``` Sets a bitmask of [SuggestionsInfo](https://developer.android.com/reference/kotlin/android/view/textservice/SuggestionsInfo) attributes that the spell checker can set in [SuggestionsInfo](https://developer.android.com/reference/kotlin/android/view/textservice/SuggestionsInfo) it returns. | Parameters || |-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `supportedAttributes` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): Value is either `0` or a combination of [android.view.textservice.SuggestionsInfo#RESULT_ATTR_IN_THE_DICTIONARY](https://developer.android.com/reference/kotlin/android/view/textservice/SuggestionsInfo#RESULT_ATTR_IN_THE_DICTIONARY:kotlin.Int), [android.view.textservice.SuggestionsInfo#RESULT_ATTR_LOOKS_LIKE_TYPO](https://developer.android.com/reference/kotlin/android/view/textservice/SuggestionsInfo#RESULT_ATTR_LOOKS_LIKE_TYPO:kotlin.Int), [android.view.textservice.SuggestionsInfo#RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS](https://developer.android.com/reference/kotlin/android/view/textservice/SuggestionsInfo#RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS:kotlin.Int), [android.view.textservice.SuggestionsInfo#RESULT_ATTR_LOOKS_LIKE_GRAMMAR_ERROR](https://developer.android.com/reference/kotlin/android/view/textservice/SuggestionsInfo#RESULT_ATTR_LOOKS_LIKE_GRAMMAR_ERROR:kotlin.Int), and [android.view.textservice.SuggestionsInfo#RESULT_ATTR_DONT_SHOW_UI_FOR_SUGGESTIONS](https://developer.android.com/reference/kotlin/android/view/textservice/SuggestionsInfo#RESULT_ATTR_DONT_SHOW_UI_FOR_SUGGESTIONS:kotlin.Int) | | Return || |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| | [SpellCheckerSession.SpellCheckerSessionParams.Builder](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#) | This value cannot be `null`. | **See Also** - [android.service.textservice.SpellCheckerService.Session#getSupportedAttributes()](https://developer.android.com/reference/kotlin/android/service/textservice/SpellCheckerService.Session.html#getSupportedAttributes())