EmojiCompat

const val EDITOR_INFO_METAVERSION_KEY = "android.support.text.emoji.emojiCompat_metadataVersion": String!

Key in extras that represents the emoji metadata version used by the widget. The existence of the value means that the widget is using EmojiCompat.

const val EDITOR_INFO_REPLACE_ALL_KEY = "android.support.text.emoji.emojiCompat_replaceAll": String!

Key in extras that represents setReplaceAll configuration parameter. The key is added only if EmojiCompat is used by the widget. If exists, the value is a boolean.

const val LOAD_STATE_DEFAULT = 3: Int

EmojiCompat instance is constructed, however the initialization did not start yet.

const val LOAD_STATE_FAILED = 2: Int

An unrecoverable error occurred during initialization of EmojiCompat. Calls to functions such as process will fail.

const val LOAD_STATE_LOADING = 0: Int

EmojiCompat is initializing.

const val LOAD_STATE_SUCCEEDED = 1: Int

EmojiCompat successfully initialized.

const val LOAD_STRATEGY_DEFAULT = 0: Int

EmojiCompat will start loading metadata when init is called.

const val LOAD_STRATEGY_MANUAL = 1: Int

EmojiCompat will wait for load to be called by developer in order to start loading metadata.

const val REPLACE_STRATEGY_ALL = 1: Int

Replace strategy to add EmojiSpans for all emoji that were found.

const val REPLACE_STRATEGY_DEFAULT = 0: Int

Replace strategy that uses the value given in EmojiCompat.Config.

const val REPLACE_STRATEGY_NON_EXISTENT = 2: Int

Replace strategy to add EmojiSpans only for emoji that do not exist in the system.

java-static fun get(): EmojiCompat!

Return singleton EmojiCompat instance. Should be called after init is called to initialize the singleton instance.

fun getAssetSignature(): String

Returns signature for the currently loaded emoji assets. The signature is a SHA that is constructed using emoji assets. Can be used to detect if currently loaded asset is different then previous executions. When used on devices running API 18 or below, returns empty string.

fun getLoadState(): Int

Returns loading state of the EmojiCompat instance. When used on devices running API 18 or below always returns LOAD_STATE_SUCCEEDED.

java-static fun handleDeleteSurroundingText(
    inputConnection: InputConnection,
    editable: Editable,
    beforeLength: @IntRange(from = 0) Int,
    afterLength: @IntRange(from = 0) Int,
    inCodePoints: Boolean
): Boolean

Handles deleteSurroundingText commands from InputConnection and tries to delete an EmojiSpan from an Editable. Returns true if an EmojiSpan is deleted.

java-static fun handleOnKeyDown(editable: Editable, keyCode: Int, event: KeyEvent!): Boolean

Handles onKeyDown commands from a KeyListener and if keyCode is one of KEYCODE_DEL or KEYCODE_FORWARD_DEL it tries to delete an EmojiSpan from an Editable. Returns true if an EmojiSpan is deleted with the characters it covers.

fun hasEmojiGlyph(sequence: CharSequence): Boolean

Returns true if EmojiCompat is capable of rendering an emoji. When used on devices running API 18 or below, always returns false.

fun hasEmojiGlyph(
    sequence: CharSequence,
    metadataVersion: @IntRange(from = 0) Int
): Boolean

Returns true if EmojiCompat is capable of rendering an emoji at the given metadata version. When used on devices running API 18 or below, always returns false.

java-static fun init(config: EmojiCompat.Config): EmojiCompat!

Initialize the singleton instance with a configuration. When used on devices running API 18 or below, the singleton instance is immediately moved into LOAD_STATE_SUCCEEDED state without loading any metadata. When called for the first time, the library will create the singleton instance and any call after that will not create a new instance and return immediately.

fun load(): Unit

When setMetadataLoadStrategy is set to LOAD_STRATEGY_MANUAL, this function starts loading the metadata. Calling the function when setMetadataLoadStrategy is not set to LOAD_STRATEGY_MANUAL will throw an exception. The load will not start if:

• the metadata is already loaded successfully and getLoadState is LOAD_STATE_SUCCEEDED.
• a previous load attempt is not finished yet and getLoadState is LOAD_STATE_LOADING.

fun process(charSequence: CharSequence): CharSequence!

Checks a given CharSequence for emojis, and adds EmojiSpans if any emojis are found. When used on devices running API 18 or below, returns the given charSequence without processing it.

fun process(
    charSequence: CharSequence,
    start: @IntRange(from = 0) Int,
    end: @IntRange(from = 0) Int
): CharSequence!

Checks a given CharSequence for emojis, and adds EmojiSpans if any emojis are found.

• If no emojis are found, charSequence given as the input is returned without any changes. i.e. charSequence is a String, and no emojis are found, the same String is returned.
• If the given input is not a Spannable (such as String), and at least one emoji is found a new android.text.Spannable instance is returned.
• If the given input is a Spannable, the same instance is returned.

fun process(
    charSequence: CharSequence,
    start: @IntRange(from = 0) Int,
    end: @IntRange(from = 0) Int,
    maxEmojiCount: @IntRange(from = 0) Int
): CharSequence!

Checks a given CharSequence for emojis, and adds EmojiSpans if any emojis are found.

• If no emojis are found, charSequence given as the input is returned without any changes. i.e. charSequence is a String, and no emojis are found, the same String is returned.
• If the given input is not a Spannable (such as String), and at least one emoji is found a new android.text.Spannable instance is returned.
• If the given input is a Spannable, the same instance is returned.

fun process(
    charSequence: CharSequence,
    start: @IntRange(from = 0) Int,
    end: @IntRange(from = 0) Int,
    maxEmojiCount: @IntRange(from = 0) Int,
    replaceStrategy: Int
): CharSequence!

Checks a given CharSequence for emojis, and adds EmojiSpans if any emojis are found.

• If no emojis are found, charSequence given as the input is returned without any changes. i.e. charSequence is a String, and no emojis are found, the same String is returned.
• If the given input is not a Spannable (such as String), and at least one emoji is found a new android.text.Spannable instance is returned.
• If the given input is a Spannable, the same instance is returned.

fun registerInitCallback(initCallback: EmojiCompat.InitCallback): Unit

Registers an initialization callback. If the initialization is already completed by the time the listener is added, the callback functions are called immediately. Callbacks are called on the main looper.

fun unregisterInitCallback(initCallback: EmojiCompat.InitCallback): Unit

Unregisters a callback that was added before.