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 EMOJI_FALLBACK = 2: Int

Result of getEmojiMatch that means the full codepoint sequence is not known to emojicompat, but at least one subsequence is an emoji that is known at this metadata level. Keyboards may decide that this emoji is not supported by the application when this result is returned, with no further processing. This return value implies: - EmojiCompat will decompose this ZWJ sequence into multiple glyphs when replaceAll=true - EmojiCompat MAY defer to platform when replaceAll=false - System emoji font may or may not support this emoji - This application MAY render this emoji This return value is only ever returned for ZWJ sequences. To understand this result consider when it may be returned for the multi-skin-tone handshake introduced in emoji 14.

    U+1FAF1 // unknown @ requested metadata level
    U+1F3FB // metadata level 1
    U+200D  // not displayed (ZWJ)
    U+1FAF2 // unknown @ requested metadata level
    U+1F3FD // metadata level 1

const val EMOJI_SUPPORTED = 1: Int

Result of getEmojiMatch that means this codepoint can be drawn by an EmojiSpan at this metadata level. No further checks are required by keyboards for this result. The emoji is always supported by this application. This return value implies: - EmojiCompat can draw this emoji - System emoji font may or may not support this emoji - This application WILL render this emoji This result implies that EmojiCompat can successfully display this emoji. The system emoji font is not checked by this method, and this result may be returned even if the platform also supports the emoji sequence. If the application passes REPLACE_STRATEGY_ALL of true, then an EmojiSpan will always be generated for this emoji. If the application passes REPLACE_STRATEGY_ALL of false, then an EmojiSpan will only be generated if hasGlyph returns false for this emoji.

const val EMOJI_UNSUPPORTED = 0: Int

Result of getEmojiMatch that means no part of this codepoint sequence will ever generate an EmojiSpan at the requested metadata level. This return value implies: - EmojiCompat will always defer to system emoji font - System emoji font may or may not support this emoji - This application MAY render this emoji This can be used by keyboards to learn that EmojiCompat does not support this codepoint sequence at this metadata version. The system emoji font is not checked by this method, and this result will be returned even if the system emoji font supports the emoji. This may happen if the application is using an older version of the emoji compat font than the system emoji font. Keyboards may optionally determine that the system emoji font will support the emoji, for example by building a internal lookup table or calling hasGlyph to query the system emoji font. Keyboards may use a lookup table to optimize this check, however they should be aware that OEMs may add or remove emoji from the system emoji font. Keyboards may finally decide: - If the system emoji font DOES NOT support the emoji, then the emoji IS NOT supported by this application. - If the system emoji font DOES support the emoji, then the emoji IS supported by this application. - If system emoji font is support is UNKNOWN, then assume the emoji IS NOT supported by this application.

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 getEmojiEnd(charSequence: CharSequence, offset: @IntRange(from = 0) Int): Int

see getEmojiStart.

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

Attempts to lookup the entire sequence at the specified metadata version and returns what the runtime match behavior would be. To be used by keyboards to show or hide emoji in response to specific metadata support.

fun getEmojiStart(charSequence: CharSequence, offset: @IntRange(from = 0) Int): Int

Together with getEmojiEnd, if the character at offset is part of an emoji, returns the index range of that emoji, start index inclusively/end index exclusively so that charSequence.subSequence(start, end) will return that emoji. E.g., getEmojiStart/End("AB😀", 1) will return (-1,-1) since 'B' is not part an emoji; getEmojiStart/End("AB😀", 3) will return [2,4), note that "😀" contains 2 Chars. Returns -1 otherwise.

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.

java-static fun init(context: Context): EmojiCompat?

Initialize the singleton instance with the default system-provided configuration.

This is the recommended configuration for most applications. For more details see DefaultEmojiCompatConfig.

This call will use DefaultEmojiCompatConfig to lookup the default emoji font provider installed on the system and use that, if present. If there is no default font provider onthe system, this call will have no effect.

Note: EmojiCompat may only be initialized once, and will return the same instance afterwords.

java-static fun isConfigured(): Boolean

Return true if EmojiCompat has been configured by a successful call to init. You can use this to check if get will return a valid EmojiCompat instance. This function does not check the getLoadState and will return true even if the font is still loading, or has failed to load.

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 registerInitCallback(
    executor: Executor,
    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.

fun unregisterInitCallback(initCallback: EmojiCompat.InitCallback): Unit

Unregisters a callback that was added before.

fun updateEditorInfo(outAttrs: EditorInfo): Unit

Updates the EditorInfo attributes in order to communicate information to Keyboards. When used on devices running API 18 or below, does not update EditorInfo attributes. This is called from EditText integrations that use EmojiEditTextHelper. Custom widgets that allow IME not subclassing EditText should call this method when creating an input connection. When EmojiCompat is not in LOAD_STATE_SUCCEEDED, this method has no effect. Calling this method on API levels below API 19 will have no effect, as EmojiCompat may never be configured. However, it is always safe to call, even on older API levels.