EmojiCompat.Config

protected Config(metadataLoader: EmojiCompat.MetadataRepoLoader)

Default constructor.

fun registerInitCallback(initCallback: EmojiCompat.InitCallback): EmojiCompat.Config

Registers an initialization callback.

fun registerInitCallback(
    executor: Executor,
    initCallback: EmojiCompat.InitCallback
): EmojiCompat.Config

Registers an initialization callback.

fun setEmojiSpanIndicatorColor(color: @ColorInt Int): EmojiCompat.Config

Sets the color used as emoji span indicator. The default value is Color.GREEN.

fun setEmojiSpanIndicatorEnabled(emojiSpanIndicatorEnabled: Boolean): EmojiCompat.Config

Determines whether a background will be drawn for the emojis that are found and replaced by EmojiCompat. Should be used only for debugging purposes. The indicator color can be set using setEmojiSpanIndicatorColor.

fun setGlyphChecker(glyphChecker: EmojiCompat.GlyphChecker): EmojiCompat.Config

The interface that is used by EmojiCompat in order to check if a given emoji can be rendered by the system.

fun setMetadataLoadStrategy(strategy: Int): EmojiCompat.Config

Determines the strategy to start loading the metadata. By default EmojiCompat will start loading the metadata during init. When set to LOAD_STRATEGY_MANUAL, you should call load to initiate metadata loading.

EmojiCompat.Config config = new FontRequestEmojiCompatConfig(context, fontRequest)
        .setMetadataLoadStrategy(EmojiCompat.LOAD_STRATEGY_MANUAL);

// EmojiCompat will not start loading metadata and MetadataRepoLoader#load(...)
// will not be called
EmojiCompat.init(config);

// At any time (i.e. idle time or executorService is ready)
// call EmojiCompat#load() to start loading metadata.
executorService.execute(() -> EmojiCompat.get().load());

fun setReplaceAll(replaceAll: Boolean): EmojiCompat.Config

Determines whether EmojiCompat should replace all the emojis it finds with the EmojiSpans. By default EmojiCompat tries its best to understand if the system already can render an emoji and do not replace those emojis.

fun setSpanFactory(factory: EmojiCompat.SpanFactory): EmojiCompat.Config

Set the span factory used to actually draw emoji replacements.

fun setUseEmojiAsDefaultStyle(useEmojiAsDefaultStyle: Boolean): EmojiCompat.Config

Determines whether EmojiCompat should use the emoji presentation style for emojis that have text style as default. By default, the text style would be used, unless these are followed by the U+FE0F variation selector. Details about emoji presentation and text presentation styles can be found here: http://unicode.org/reports/tr51/#Presentation_Style If useEmojiAsDefaultStyle is true, the emoji presentation style will be used for all emojis, including potentially unexpected ones (such as digits or other keycap emojis). If this is not the expected behaviour, method setUseEmojiAsDefaultStyle can be used to specify the exception emojis that should be still presented as text style.

fun unregisterInitCallback(initCallback: EmojiCompat.InitCallback): EmojiCompat.Config

Unregisters a callback that was added before.

protected fun getMetadataRepoLoader(): EmojiCompat.MetadataRepoLoader

Returns the MetadataRepoLoader.