The eventBus instance can be retrieved only from the KeyboardService after calling super.onCreate.

Summary

Example:

eventBus.configuration.subscribe {
    when (it) {
        is ConfigurationEvent.CurrentLanguageChanged -> {
            mySettings.setCurrentLanguage(it.locale)
        }
    }
}

ConfigurationEvent

A ConfigurationEvent is sent every time a user makes a configuration change on the keyboard through gestures or buttons. It is advised to store the configuration change in permanent storage, such as SharedPreferences and use that value in the createConfiguration method of the KeyboardService.

CurrentLanguageChanged

Inherits from ConfigurationEvent.

The user switched to another language from the list of userLanguages provided in the LanguageConfiguration.

data class CurrentLanguageChanged(val locale: String)

Fields:

AutoCorrectionChanged

Inherits from ConfigurationEvent.

The user toggled the auto correction.

data class AutoCorrectionChanged(val enabled: Boolean)

Fields:

LanguageNotAvailable

Inherits from ConfigurationEvent.

An attempt to load a new language has failed and is not recoverable. The next language in the list of userLanguages will be loaded, falling back to the default language (en-US) when the list of available languages is empty.

Notes:

• The brokenLocale should be removed from the userLanguages in the LanguageConfiguration upon receiving this event. No updateConfiguration call is needed.

data class LanguageNotAvailable(val brokenLocale: String, val nextLocale: String)

Fields:

DictionaryEvent

A DictionaryEvent is sent every time a user makes a change to the user dictionary. Chnages can happen via the suggestion gestures to add or remove a word, or via automatic learning when the user corrects words manually.

AddUserWord

Inherits from ConfigurationEvent.

The user added a new word to their dictionary.

data class AddUserWord(val word: String)

RemoveUserWord

Inherits from ConfigurationEvent.

The user removed a word from their dictionary.

data class RemoveUserWord(val word: String)

AutoLearnedWord

Inherits from ConfigurationEvent.

The engine learned a new user word automatically. This event is sent when the user changes an autocorrected word.

data class AutoLearnedWord(val word: String)

EngineEvent

An EngineEvent is sent when the engine has a new tracking message, usually for debugging purposes, when tracking is enabled in the PrivacyConfiguration.

MessageReceived

Inherits from EngineEvent.

The engine sent a tracking message.

data class MessageReceived(val message: String)

ReportAnalytics

Inherits from EngineEvent.

The engine sent an AC analytics report.

data class ReportAnalytics( 
        val languageCode: String?,
        val none: Int,
        val missingSpace: Int,
        val missTypedSpace: Int,
        val eliminated: Int,
        val transposition: Int,
        val missingTaps: Int,
        val others: Int
)

MonitorEvent

A MonitorEvent is sent when the content extraction is enabled via the MonitorConfiguration.

PartialExtraction

Inherits from MonitorEvent.

The underlying editor sent a partial extraction. This event is sent when the extraction mode is set to EXTRACTED.

data class PartialExtraction(
val text: CharSequence, 
val startOffset: Int, 
val partialStartOffset: Int, 
val partialEndOffset: Int
)

TextExtraction

Inherits from MonitorEvent.

When the extraction mode is set to EXTRACTED, the underlying editor sends a non-partial extraction. When the extraction mode is set to AGGREGATE, the extracted text from the underlying editor has been aggregated. It is then sent as a complete text extraction.

data class TextExtraction(
val text: CharSequence, 
val startOffset: Int, 
val partialStartOffset: Int, 
val partialEndOffset: Int
)

ComposingExtraction

Inherits from MonitorEvent.

When composing is enabled in the MonitorConfiguration, engine composing operations are delivered as events.

Notes:

• Spaces and punctuation symbols are not composed.
• Compositions might not reflect the entire word being edited.

data class ComposingExtraction(
val text: CharSequence, 
val start: Int, 
val end: Int
)

ComposingCorrection

Inherits from MonitorEvent.

When an auto correction is triggered during a composition, an event is sent with the correction and the previous text is used.

data class ComposingCorrection(
val corrected: CharSequence, 
val original: CharSequence
)

Input

Inherits from MonitorEvent.

When a soft input operation has been performed, such as tapping a letter or spacebar button, an Input event is set, only when MonitorConfiguration has been configured to emit these events. See InputValidator for details on what labels and key codes are sent.

Note:

• These events are sent after the operation has been performed on the underlying editor and only when the input validation passes.

data class Input(
val label: String, 
val keyCode: Int,
val startTimestamp: Long,
val endTimestamp: Long
)

EditorChanged

Inherits from MonitorEvent.

When a user switches to a temporary editor (i.e. search box inside a keyboard app), an EditorChanged event is sent with the full contents of the current editor.

Note:

• This event is not delivered when the user changes editors within a mobile application or across mobile applications.

data class EditorChanged(
val text: String
)

ServiceEvent

A ServiceEvent is a propagated event that the keyboard service receives.

PackageNameChanged

Inherits from ServiceEvent.

The engine has received new editor information for a new application package.

data class PackageNameChanged(val packageName: String)

CurrentThemeChanged

Inherits from ServiceEvent.

The engine has received and processed a theme change request.

data class CurrentThemeChanged(val theme: KeyboardTheme)

WindowInsetsChanged

Inherits from ServiceEvent.

The engine has received and processed a window insets change request.

data class WindowInsetsChanged(val windowInsets: KeyboardInsets)

ActivityEvent

An ActivityEvent is used to report user actions.

KeyboardAction

Inherits from ActivityEvent

The user performed an action or gesture on the keyboard.

data class KeyboardAction(val type: ActionType) : ActivityEvent() {
    enum class ActionType {
        BACKSPACE,
        SPACEBAR,
        MICROPHONE,
        SWIPE_LEFT,
        SWIPE_RIGHT,
        PUNCTUATION_HOLD,
        SHIFT_HOLD,
        SHOW_EMOJIS,
        SHOW_STT,
        SHOW_TRACKPAD,
        HIDE_EMOJIS,
        HIDE_TRACKPAD,
        HIDE_STT
    }
}

LanguageChanged

Inherits from ActivityEvent

The user performed a language change via a gesture.

data class LanguageChanged(val locale: String) : ActivityEvent()

EmojiSent

Inherits from ActivityEvent

The user selected an emoji from the emoji panel. The variationSource field determines the base emoji, if any, which should be used when sending the emoji variations configuration.

data class EmojiSent(
val emoji: String, 
val variationSource: String? = null
) : ActivityEvent()

KeyboardShown

Inherits from ActivityEvent

An event sent every time the input view becomes visible.

data class KeyboardShown(val start: Long) : ActivityEvent()

KeyboardHidden

Inherits from ActivityEvent

An event which is sent every time the input view is hidden.

data class KeyboardHidden(
val start: Long, 
val end: Long, 
val duration: Long
) : ActivityEvent()

MagicHold

Inherits from ActivityEvent

An event sent every time the user holds down the magic button.

data class MagicHold(val icon: Icon) : ActivityEvent()

Prediction

Inherits from ActivityEvent

An event sent every time the user taps on a word or emoji prediction.

sealed class Prediction : ActivityEvent() {
    data class Emoji(val emoji: String) : Prediction()
    data class Word(val word: String) : Prediction()
}

PredictionsEvent

A PredictionEvent is a propagated event for the predictions being displayed.

Note:

• Prediction Events should only be consumed for advanced prediction management.

Suggestions

Inherits from PredictionEvent

The engine has received a list of suggestions for the previous word.

data class Suggestions(
  val suggestions: List<String>, 
  val selectedIndex: Int, 
  val type: Int
)

Type can be any of:

• 0 => Regular suggestions
• 1 => Punctuation suggestions
• 2 => Request to clear suggestions

CurrentWordPredictions

Inherits from PredictionEvent

The engine has received a list of suggestions for the current word.

data class CurrentWordPredictions(val predictions: List<Pair<String, Int>>)

Type of a prediction can be any of:

• 0 => Entered Text directly from the user
• 1 => Suggestion word
• 2 => Word that the engine will autocorrect
• 3 => Word entered by the user is the same as the one that the engine will correct
• 4 => Emoji suggestion
• 5 => Other

HighlightSuggestions

Inherits from PredictionEvent

The engine has received a list of suggestions and highlights for the next word or service.

data class Suggestions(val enumType: String?, val jsonString: String?)

enumType can be any of:

• highlightEventPop
• highlightEventKeywordMatch
• highlightEventNSP
• highlightEventNWP
• highlightEventEmoji
• highlightEventAll

GenericDataEvent

A GenericDataEvent is an event for the data captured during the session.

Session

This event is emitted when the SDK has received a session data. It includes the data received.

SessionStarted

This event is emitted when the SDK has started a new session. It includes the sessionId of the started event.

SessionEnded

This event is emitted when the SDK has ended an existing session. It includes the sessionId of the event that has ended.

SessionStored

This event is emitted when the SDK has stored a session data. It includes the path where the data is stored.

EventBasedDataCapture

An event that reports when the data capture system has data to report. In order to receive data you should do:

1. Subscribe to any of the following events.
2. Enable the DataCaptureMode from the KeyboardConfiguration.
3. Make sure that your developer plan has this capability enabled. Make sure that your current plan supports it. Check it here: developers platform

All these events should be subscribed as any other event. An example on how to use these events is provided in our github repository.

SessionUpdateCaptureEvent

Emit this event every time the data of the session has changed.

The data of this event is equal for Android and iOS. Check it here the data content.

KeyStrokeCaptureEvent

Emit an event when a key stroke has been pressed. The event is emitted when the touch ends and the system has processed it.

The data of this event is equal for Android and iOS. Check it here the data content.

WordCaptureEvent

Emit an event when the last word has been added. This means that a space after a word has been inserted, a predictions has been pressed or the autocorrection has changed the word for another one.

The data of this event is equal for Android and iOS. Check it here the data content.

DeleteCaptureEvent

Emit an event when a delete event has been triggered.

The data of this event is equal for Android and iOS. Check it here the data content.

SwipeCaptureEvent

Emit an event when swipe data has been created. After the end-user finishes the swipe typing and the word is added in the edittext.

The data of this event is equal for Android and iOS. Check it here the data content.

KeyPlaneCaptureEvent

Emit an event when the key plane has changed. Note that the keyplane might change automatically depending on the keys that you press.

The data of this event is equal for Android and iOS. Check it here the data content.

StressUpdateCaptureEvent

Emit an event when the stress data has been updated.

The data of this event is equal for Android and iOS. Check it here the data content.