# SpellCheckerSession Added in[API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary:[Nested Classes](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession#nestedclasses)\|[Constants](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession#constants)\|[Methods](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession#pubmethods)\|[Protected Methods](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession#promethods)\|[Inherited Methods](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession#inhmethods) # SpellCheckerSession *** ** * ** *** [Kotlin](https://developer.android.com/reference/kotlin/android/view/textservice/SpellCheckerSession "View this page in Kotlin")\|Java ` public class SpellCheckerSession ` ` 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 |
*** ** * ** *** The SpellCheckerSession interface provides the per client functionality of SpellCheckerService. ### Applications In most cases, applications that are using the standard[TextView](https://developer.android.com/reference/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[R.attr.inputType](https://developer.android.com/reference/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)](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession#getSuggestions(android.view.textservice.TextInfo,%20int))or[getSuggestions(android.view.textservice.TextInfo[], int, boolean)](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession#getSuggestions(android.view.textservice.TextInfo[],%20int,%20boolean))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,[TextView](https://developer.android.com/reference/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[SpellCheckerService](https://developer.android.com/reference/android/service/textservice/SpellCheckerService)interface, via the[Manifest.permission.BIND_TEXT_SERVICE](https://developer.android.com/reference/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 | ### Nested classes || |--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` interface` | [SpellCheckerSession.SpellCheckerSessionListener](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionListener) Callback for getting results from text services | | ` class` | [SpellCheckerSession.SpellCheckerSessionParams](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams) Parameters used to create a[SpellCheckerSession](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession). | | ### Constants || |--------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [String](https://developer.android.com/reference/java/lang/String) | [SERVICE_META_DATA](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession#SERVICE_META_DATA) Name under which a SpellChecker service component publishes information about itself. | | ### Public methods || |----------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` void` | ` `[cancel](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession#cancel())`() ` Cancel pending and running spell check tasks | | ` void` | ` `[close](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession#close())`() ` Finish this session and allow TextServicesManagerService to disconnect the bound spell checker. | | ` void` | ` `[getSentenceSuggestions](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession#getSentenceSuggestions(android.view.textservice.TextInfo[],%20int))`(`[TextInfo[]](https://developer.android.com/reference/android/view/textservice/TextInfo)` textInfos, int suggestionsLimit) ` Get suggestions from the specified sentences | | ` `[SpellCheckerInfo](https://developer.android.com/reference/android/view/textservice/SpellCheckerInfo) | ` `[getSpellChecker](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession#getSpellChecker())`() ` Get the spell checker service info this spell checker session has. | | ` void` | ` `[getSuggestions](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession#getSuggestions(android.view.textservice.TextInfo,%20int))`(`[TextInfo](https://developer.android.com/reference/android/view/textservice/TextInfo)` textInfo, int suggestionsLimit) ` *This method was deprecated in API level 16. use[SpellCheckerSession.getSentenceSuggestions(TextInfo[], int)](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession#getSentenceSuggestions(android.view.textservice.TextInfo[],%20int))instead* | | ` void` | ` `[getSuggestions](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession#getSuggestions(android.view.textservice.TextInfo[],%20int,%20boolean))`(`[TextInfo[]](https://developer.android.com/reference/android/view/textservice/TextInfo)` textInfos, int suggestionsLimit, boolean sequentialWords) ` *This method was deprecated in API level 16. use[SpellCheckerSession.getSentenceSuggestions(TextInfo[], int)](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession#getSentenceSuggestions(android.view.textservice.TextInfo[],%20int))instead* | | ` boolean` | ` `[isSessionDisconnected](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession#isSessionDisconnected())`() ` | | ### Protected methods || |---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` void` | ` `[finalize](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ### 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*. | || ## Constants ### SERVICE_META_DATA Added in[API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static final String SERVICE_META_DATA ``` Name under which a SpellChecker service component publishes information about itself. This meta-data must reference an XML resource.
Constant Value: "android.view.textservice.scs" ## Public methods ### cancel Added in[API level 15](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public void cancel () ``` Cancel pending and running spell check tasks
### close Added in[API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public void close () ``` Finish this session and allow TextServicesManagerService to disconnect the bound spell checker.
### getSentenceSuggestions Added in[API level 16](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public void getSentenceSuggestions (TextInfo[] textInfos, int suggestionsLimit) ``` Get suggestions from the specified sentences
| Parameters || |--------------------|-----------------------------------------------------------------------| | `textInfos` | `TextInfo`: an array of text metadata for a spell checker
| | `suggestionsLimit` | `int`: the maximum number of suggestions that will be returned
| ### getSpellChecker Added in[API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public SpellCheckerInfo getSpellChecker () ``` Get the spell checker service info this spell checker session has.
| Returns || |-------------------------------------------------------------------------------------------------------|---------------------------------------------------| | [SpellCheckerInfo](https://developer.android.com/reference/android/view/textservice/SpellCheckerInfo) | SpellCheckerInfo for the specified locale.
| ### getSuggestions Added in[API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Deprecated in[API level 16](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public void getSuggestions (TextInfo textInfo, int suggestionsLimit) ```
**This method was deprecated in API level 16.** use[SpellCheckerSession.getSentenceSuggestions(TextInfo[], int)](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession#getSentenceSuggestions(android.view.textservice.TextInfo[],%20int))instead Get candidate strings for a substring of the specified text.
| Parameters || |--------------------|-----------------------------------------------------------------------| | `textInfo` | `TextInfo`: text metadata for a spell checker
| | `suggestionsLimit` | `int`: the maximum number of suggestions that will be returned
| ### getSuggestions Added in[API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Deprecated in[API level 16](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public void getSuggestions (TextInfo[] textInfos, int suggestionsLimit, boolean sequentialWords) ```
**This method was deprecated in API level 16.** use[SpellCheckerSession.getSentenceSuggestions(TextInfo[], int)](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession#getSentenceSuggestions(android.view.textservice.TextInfo[],%20int))instead A batch process of getSuggestions
| Parameters || |--------------------|-------------------------------------------------------------------------| | `textInfos` | `TextInfo`: an array of text metadata for a spell checker
| | `suggestionsLimit` | `int`: the maximum number of suggestions that will be returned
| | `sequentialWords` | `boolean`: true if textInfos can be treated as sequential words.
| ### isSessionDisconnected Added in[API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public boolean isSessionDisconnected () ```

| Returns || |-----------|------------------------------------------------------------------------------------------------| | `boolean` | true if the connection to a text service of this session is disconnected and not alive.
| ## Protected methods ### finalize Added in[API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` protected void finalize () ``` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the`finalize`method to dispose of system resources or to perform other cleanup. The general contract of`finalize`is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The`finalize`method may take any action, including making this object available again to other threads; the usual purpose of`finalize`, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded. The`finalize`method of class`Object`performs no special action; it simply returns normally. Subclasses of`Object`may override this definition. The Java programming language does not guarantee which thread will invoke the`finalize`method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates. After the`finalize`method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded. The`finalize`method is never invoked more than once by a Java virtual machine for any given object. Any exception thrown by the`finalize`method causes the finalization of this object to be halted, but is otherwise ignored.
| Throws || |--------------------------------------------------------------------------|---| | [Throwable](https://developer.android.com/reference/java/lang/Throwable) | |