Added in API level 31

SpellCheckerSessionParams

---

Kotlin |Java

open class SpellCheckerSessionParams

kotlin.Any
↳	android.view.textservice.SpellCheckerSession.SpellCheckerSessionParams

Parameters used to create a SpellCheckerSession.

Summary

Nested classes
	Builder Builder of SpellCheckerSessionParams.

Public methods
open Bundle	getExtras() Returns a bundle containing extra parameters for the spell checker.
open Locale?	getLocale() Returns the locale in which the spell checker should operate.
open Int	getSupportedAttributes() Returns a bitmask of SuggestionsInfo attributes that the spell checker can set in SuggestionsInfo it returns.
open Boolean	shouldReferToSpellCheckerLanguageSettings() Returns true if the user's spell checker language settings should be used to determine the spell checker locale.

Public methods

getExtras

Added in API level 31

open fun getExtras(): Bundle

Returns 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 implementation.

Return
Bundle	This value cannot be null.

See Also

• android.service.textservice.SpellCheckerService.Session#getBundle()

getLocale

Added in API level 31

open fun getLocale(): Locale?

Returns the locale in which the spell checker should operate.

Return
Locale?	This value may be null.

See Also

• android.service.textservice.SpellCheckerService.Session#getLocale()

getSupportedAttributes

Added in API level 31

open fun getSupportedAttributes(): Int

Returns a bitmask of SuggestionsInfo attributes that the spell checker can set in SuggestionsInfo it returns.

Return

Int

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

See Also

• android.service.textservice.SpellCheckerService.Session#getSupportedAttributes()

shouldReferToSpellCheckerLanguageSettings

Added in API level 31

open fun shouldReferToSpellCheckerLanguageSettings(): Boolean

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