FontRequestEmojiCompatConfig

class FontRequestEmojiCompatConfig : EmojiCompat.Config

kotlin.Any
   ↳ androidx.emoji2.text.EmojiCompat.Config
     ↳ androidx.emoji2.text.FontRequestEmojiCompatConfig

EmojiCompat.Config implementation that asynchronously fetches the required font and the metadata using a FontRequest. FontRequest should be constructed to fetch an EmojiCompat compatible emoji font.

Summary

Nested types

A retry policy implementation that doubles the amount of time in between retries.

Retry policy used when the font provider is not ready to give the font file.

Public constructors

Public functions
FontRequestEmojiCompatConfig
setHandler(handler: Handler?)

This function is deprecated.

please call setLoadingExecutor instead
FontRequestEmojiCompatConfig

Sets the custom executor to be used for initialization.
FontRequestEmojiCompatConfig

Sets the retry policy.

Inherited functions
From androidx.emoji2.text.EmojiCompat.Config
EmojiCompat.MetadataRepoLoader

Returns the MetadataRepoLoader.
EmojiCompat.Config

Registers an initialization callback.
EmojiCompat.Config
registerInitCallback(
    executor: Executor,
    initCallback: EmojiCompat.InitCallback
)

Registers an initialization callback.
EmojiCompat.Config

Sets the color used as emoji span indicator.
EmojiCompat.Config
setEmojiSpanIndicatorEnabled(emojiSpanIndicatorEnabled: Boolean)

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

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

Determines the strategy to start loading the metadata.
EmojiCompat.Config
setReplaceAll(replaceAll: Boolean)

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

Set the span factory used to actually draw emoji replacements.
EmojiCompat.Config
setUseEmojiAsDefaultStyle(useEmojiAsDefaultStyle: Boolean)

Determines whether EmojiCompat should use the emoji presentation style for emojis that have text style as default.
EmojiCompat.Config
setUseEmojiAsDefaultStyle(
    useEmojiAsDefaultStyle: Boolean,
    emojiAsDefaultStyleExceptions: (Mutable)List<Int!>?
)
EmojiCompat.Config

Unregisters a callback that was added before.

Public constructors

FontRequestEmojiCompatConfig

Added in 1.0.0
FontRequestEmojiCompatConfig(context: Context, request: FontRequest)
Parameters
context: Context

Context instance, cannot be null
request: FontRequest

FontRequest to fetch the font asynchronously, cannot be null

Public functions

setHandler

Added in 1.0.0
Deprecated in 1.0.0
fun setHandler(handler: Handler?): FontRequestEmojiCompatConfig

Please us setLoadingExecutor instead to set background loading thread. This was deprecated in emoji2 1.0.0-alpha04. If migrating from androidx.emoji please prefer to use an existing background executor for setLoadingExecutor. Note: This method will no longer have any effect if passed null, which is a breaking change from androidx.emoji.

Parameters
handler: Handler?

background thread handler to wrap in an Executor, if null this method will do nothing

setLoadingExecutor

Added in 1.0.0
fun setLoadingExecutor(executor: Executor): FontRequestEmojiCompatConfig

Sets the custom executor to be used for initialization. Since font loading is too slow for the main thread, the metadata loader will fetch the fonts on a background thread. By default, FontRequestEmojiCompatConfig will create its own single threaded Executor, which causes a thread to be created. You can pass your own executor to control which thread the font is loaded on, and avoid an extra thread creation.

Parameters
executor: Executor

background executor for performing font load

setRetryPolicy

Added in 1.0.0
fun setRetryPolicy(policy: FontRequestEmojiCompatConfig.RetryPolicy?): FontRequestEmojiCompatConfig

Sets the retry policy. {@see RetryPolicy}

Parameters
policy: FontRequestEmojiCompatConfig.RetryPolicy?

The policy to be used when the font provider is not ready to give the font file. Can be null. In case of null, the metadata loader never retries.