Config

abstract class Config
kotlin.Any
   ↳ androidx.emoji.text.EmojiCompat.Config

Configuration class for EmojiCompat. Changes to the values will be ignored after init(Config) is called.

Summary

Protected constructors
<init>(@NonNull metadataLoader: EmojiCompat.MetadataRepoLoader)

Default constructor.

Public methods
open EmojiCompat.Config!

Sets the color used as emoji span indicator.

open EmojiCompat.Config!

Determines the strategy to start loading the metadata.

open EmojiCompat.Config!
setEmojiSpanIndicatorEnabled(emojiSpanIndicatorEnabled: Boolean)

Determines whether a background will be drawn for the emojis that are found and replaced by EmojiCompat.

open EmojiCompat.Config!
setReplaceAll(replaceAll: Boolean)

Determines whether EmojiCompat should replace all the emojis it finds with the EmojiSpans.

open EmojiCompat.Config!

Unregisters a callback that was added before.

open EmojiCompat.Config!
setUseEmojiAsDefaultStyle(useEmojiAsDefaultStyle: Boolean)

Determines whether EmojiCompat should use the emoji presentation style for emojis that have text style as default.

open EmojiCompat.Config!
setUseEmojiAsDefaultStyle(useEmojiAsDefaultStyle: Boolean, @Nullable emojiAsDefaultStyleExceptions: MutableList<Int!>?)

open EmojiCompat.Config!

Registers an initialization callback.

Protected methods
EmojiCompat.MetadataRepoLoader!

Returns the MetadataRepoLoader.

Protected constructors

<init>

protected Config(@NonNull metadataLoader: EmojiCompat.MetadataRepoLoader)

Default constructor.

Parameters
metadataLoader EmojiCompat.MetadataRepoLoader: MetadataRepoLoader instance, cannot be null

Public methods

setEmojiSpanIndicatorColor

open fun setEmojiSpanIndicatorColor(color: Int): EmojiCompat.Config!

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

setMetadataLoadStrategy

open fun setMetadataLoadStrategy(strategy: Int): EmojiCompat.Config!

Determines the strategy to start loading the metadata. By default will start loading the metadata during . When set to , you should call

Default implementations of EmojiCompat.MetadataRepoLoader start a thread during their EmojiCompat.MetadataRepoLoader#load functions. Just instantiating and starting a thread might take time especially in older devices. Since EmojiCompat#init(Config) has to be called before any EmojiCompat widgets are inflated, this results in time spent either on your Application.onCreate or Activity .onCreate. If you'd like to gain more control on when to start loading the metadata and be able to call EmojiCompat#init(Config) with absolute minimum time cost you can use EmojiCompat#LOAD_STRATEGY_MANUAL.

When set to EmojiCompat#LOAD_STRATEGY_MANUAL, EmojiCompat will wait for load() to be called by the developer in order to start loading metadata, therefore you should call EmojiCompat#load() to initiate metadata loading. load() can be called from any thread.
 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()); 
Parameters
strategy Int: one of EmojiCompat#LOAD_STRATEGY_DEFAULT, EmojiCompat#LOAD_STRATEGY_MANUAL

setEmojiSpanIndicatorEnabled

open 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(int).

Parameters
emojiSpanIndicatorEnabled Boolean: when true a background is drawn for each emoji that is replaced

setReplaceAll

open 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.

Parameters
replaceAll Boolean: replace all emojis found with EmojiSpans
Return
EmojiCompat.Config!: EmojiCompat.Config instance

unregisterInitCallback

open fun unregisterInitCallback(@NonNull initCallback: EmojiCompat.InitCallback): EmojiCompat.Config!

Unregisters a callback that was added before.

Parameters
initCallback EmojiCompat.InitCallback: the initialization callback to be removed, cannot be null
Return
EmojiCompat.Config!: EmojiCompat.Config instance

setUseEmojiAsDefaultStyle

open 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(boolean, List) can be used to specify the exception emojis that should be still presented as text style.

Parameters
useEmojiAsDefaultStyle Boolean: whether to use the emoji style presentation for all emojis that would be presented as text style by default

setUseEmojiAsDefaultStyle

open fun setUseEmojiAsDefaultStyle(useEmojiAsDefaultStyle: Boolean, @Nullable emojiAsDefaultStyleExceptions: MutableList<Int!>?): EmojiCompat.Config!
Parameters
emojiAsDefaultStyleExceptions Boolean: Contains the exception emojis which will be still presented as text style even if the useEmojiAsDefaultStyle flag is set to true. This list will be ignored if useEmojiAsDefaultStyle is false. Note that emojis with default emoji style presentation will remain emoji style regardless the value of useEmojiAsDefaultStyle or whether they are included in the exceptions list or not. When no exception is wanted, the method setUseEmojiAsDefaultStyle(boolean) should be used instead.

registerInitCallback

open fun registerInitCallback(@NonNull initCallback: EmojiCompat.InitCallback): EmojiCompat.Config!

Registers an initialization callback.

Parameters
initCallback EmojiCompat.InitCallback: the initialization callback to register, cannot be null
Return
EmojiCompat.Config!: EmojiCompat.Config instance

Protected methods

getMetadataRepoLoader

protected fun getMetadataRepoLoader(): EmojiCompat.MetadataRepoLoader!

Returns the MetadataRepoLoader.