CandidateType

enum class CandidateType

A class that contains the type of Candidates.

Summary

Enums
AUTOCORRECTION The word at the cursor is predicted, one or more replacements are offered.
AUTOCOMPLETION The word at the cursor is predicted, one or more replacements are offered
DICTIONARY A word that is present in the dictionary.
EMOJI A word could be added or replaced by an emoji.
OTHER
PREDICTION The next word at the cursor is predicted, one or more additions are offered.

Enums

AUTOCORRECTION

AUTOCORRECTION

The word at the cursor was misspelled, one or more corrections are needed.
Example: “Hello wrld|” => [(“world”, 6-10), (“wald”, 6-10), (“weld”, 6-10)]

AUTOCOMPLETION

AUTOCOMPLETION

The next word at the cursor is predicted, one or more additions are offered.
Example: “Hello grand|” => [(“grandparent”, 6-11), (“granddaughter”, 6-11), …]

DICTIONARY

DICTIONARY

A word that is present in the dictionary.
Example dictionary word: “The art|” => [(“art”, 5-7, DICTIONARY), (“article”, 5-7, AUTOCOMPLETION)]

EMOJI

EMOJI

A word could be added or replaced by an emoji.
Example emoji suggestion: “A rose|” => [("🌹", 2-6)]

OTHER

OTHER

PREDICTION

PREDICTION

The next word at the cursor is predicted, one or more additions are offered.
Example: “Hello |” => [(“world,6-6”), (“there”, 6-6)]


If something needs to be added or if you find an error in our documentation, please let us know either on our GitHub or Discord.

Last updated on July 29, 2022