EmojiCompat

public static final String EDITOR_INFO_METAVERSION_KEY = "android.support.text.emoji.emojiCompat_metadataVersion"

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.

public static final String EDITOR_INFO_REPLACE_ALL_KEY = "android.support.text.emoji.emojiCompat_replaceAll"

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.

public static final int LOAD_STATE_DEFAULT = 3

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

public static final int LOAD_STATE_FAILED = 2

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

public static final int LOAD_STATE_LOADING = 0

EmojiCompat is initializing.

public static final int LOAD_STATE_SUCCEEDED = 1

EmojiCompat successfully initialized.

public static final int LOAD_STRATEGY_DEFAULT = 0

EmojiCompat will start loading metadata when init is called.

public static final int LOAD_STRATEGY_MANUAL = 1

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

public static final int REPLACE_STRATEGY_ALL = 1

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

public static final int REPLACE_STRATEGY_DEFAULT = 0

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

public static final int REPLACE_STRATEGY_NON_EXISTENT = 2

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

public static EmojiCompat get()

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

public @NonNull String getAssetSignature()

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.

public int getLoadState()

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

public static boolean handleDeleteSurroundingText(
    @NonNull InputConnection inputConnection,
    @NonNull Editable editable,
    @IntRange(from = 0) int beforeLength,
    @IntRange(from = 0) int afterLength,
    boolean inCodePoints
)

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

public static boolean handleOnKeyDown(@NonNull Editable editable, int keyCode, KeyEvent event)

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.

public boolean hasEmojiGlyph(@NonNull CharSequence sequence)

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

public boolean hasEmojiGlyph(
    @NonNull CharSequence sequence,
    @IntRange(from = 0) int metadataVersion
)

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.

public static EmojiCompat init(@NonNull EmojiCompat.Config config)

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.

public void load()

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.

public CharSequence process(@NonNull 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.

public CharSequence process(
    @NonNull CharSequence charSequence,
    @IntRange(from = 0) int start,
    @IntRange(from = 0) int end
)

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.

public CharSequence process(
    @NonNull CharSequence charSequence,
    @IntRange(from = 0) int start,
    @IntRange(from = 0) int end,
    @IntRange(from = 0) int maxEmojiCount
)

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.

public CharSequence process(
    @NonNull CharSequence charSequence,
    @IntRange(from = 0) int start,
    @IntRange(from = 0) int end,
    @IntRange(from = 0) int maxEmojiCount,
    int replaceStrategy
)

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.

public void registerInitCallback(@NonNull EmojiCompat.InitCallback initCallback)

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.

public void unregisterInitCallback(@NonNull EmojiCompat.InitCallback initCallback)

Unregisters a callback that was added before.