SpellCheckerSession

open class SpellCheckerSession

The SpellCheckerSession interface provides the per client functionality of SpellCheckerService.

Applications

In most cases, applications that are using the standard android.widget.TextView or its subclasses will have little they need to do to work well with spell checker services. The main things you need to be aware of are:

• Properly set the android.R.attr#inputType in your editable text views, so that the spell checker will have enough context to help the user in editing text in them.

For the rare people amongst us writing client applications that use the spell checker service directly, you will need to use getSuggestions(android.view.textservice.TextInfo,int) or getSuggestions(android.view.textservice.TextInfo[],int,boolean) for obtaining results from the spell checker service by yourself.

Security

There are a lot of security issues associated with spell checkers, since they could monitor all the text being sent to them through, for instance, android.widget.TextView. The Android spell checker framework also allows arbitrary third party spell checkers, so care must be taken to restrict their selection and interactions.

Here are some key points about the security architecture behind the spell checker framework:

• Only the system is allowed to directly access a spell checker framework's android.service.textservice.SpellCheckerService interface, via the android.Manifest.permission#BIND_TEXT_SERVICE permission. This is enforced in the system by not binding to a spell checker service that does not require this permission.
• The user must explicitly enable a new spell checker in settings before they can be enabled, to confirm with the system that they know about it and want to make it available for use.

Summary

Constants

static val SERVICE_META_DATA: String

Value: "android.view.textservice.scs"

Public methods

open fun cancel(): Unit

open fun close(): Unit

open fun getSentenceSuggestions(
    textInfos: Array<TextInfo!>!, 
    suggestionsLimit: Int
): Unit

open fun getSpellChecker(): SpellCheckerInfo!

open fun getSuggestions(
    textInfo: TextInfo!, 
    suggestionsLimit: Int
): Unit

open fun getSuggestions(
    textInfos: Array<TextInfo!>!, 
    suggestionsLimit: Int, 
    sequentialWords: Boolean
): Unit

open fun isSessionDisconnected(): Boolean

Protected methods

protected open fun finalize(): Unit