PlatformSpellChecker/com.darkrockstudios.libs.platformspellchecker/DictionaryScope

DictionaryScope

enum DictionaryScope : Enum<DictionaryScope> (source)

Scope of a custom-dictionary mutation.

Spell-check results always treat AppLocal words as correct on every platform. System additionally delegates to the platform's native learn/unlearn mechanism where one exists.

Entries

AppLocal

In-memory, app-private. Persists only for the lifetime of this PlatformSpellChecker instance. Callers that want cross-session persistence should snapshot via PlatformSpellChecker.userDictionary and re-seed on startup.

System

Uses the platform's native user-dictionary mechanism, which persists across app restarts. Scope of that persistence varies:

Properties

entries

val entries: EnumEntries<DictionaryScope>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

valueOf

fun valueOf(value: String): DictionaryScope

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<DictionaryScope>

Returns an array containing the constants of this enum type, in the order they're declared.