FontRequestEmojiCompatConfig

Artifact: androidx.emoji:emoji

View Source

Added in 1.0.0

---

Kotlin |Java

public class FontRequestEmojiCompatConfig extends EmojiCompat.Config

java.lang.Object
↳	androidx.emoji.text.EmojiCompat.Config
	↳	androidx.emoji.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
public class FontRequestEmojiCompatConfig.ExponentialBackoffRetryPolicy extends FontRequestEmojiCompatConfig.RetryPolicy A retry policy implementation that doubles the amount of time in between retries.
public abstract class FontRequestEmojiCompatConfig.RetryPolicy Retry policy used when the font provider is not ready to give the font file.

Public constructors
FontRequestEmojiCompatConfig(     @NonNull Context context,     @NonNull FontRequest request )

Public methods
FontRequestEmojiCompatConfig	setHandler(Handler handler) Sets the custom handler to be used for initialization.
FontRequestEmojiCompatConfig	setRetryPolicy(FontRequestEmojiCompatConfig.RetryPolicy policy) Sets the retry policy.

Inherited methods

From androidx.emoji.text.EmojiCompat.Config final EmojiCompat.MetadataRepoLoader getMetadataRepoLoader() Returns the MetadataRepoLoader. EmojiCompat.Config registerInitCallback(@NonNull EmojiCompat.InitCallback initCallback) Registers an initialization callback. EmojiCompat.Config setEmojiSpanIndicatorColor(@ColorInt int color) Sets the color used as emoji span indicator. EmojiCompat.Config setEmojiSpanIndicatorEnabled(boolean emojiSpanIndicatorEnabled) Determines whether a background will be drawn for the emojis that are found and replaced by EmojiCompat. @NonNull EmojiCompat.Config setGlyphChecker(@NonNull EmojiCompat.GlyphChecker glyphChecker) The interface that is used by EmojiCompat in order to check if a given emoji can be rendered by the system. EmojiCompat.Config setMetadataLoadStrategy(int strategy) Determines the strategy to start loading the metadata. EmojiCompat.Config setReplaceAll(boolean replaceAll) Determines whether EmojiCompat should replace all the emojis it finds with the EmojiSpans. EmojiCompat.Config setUseEmojiAsDefaultStyle(boolean useEmojiAsDefaultStyle) Determines whether EmojiCompat should use the emoji presentation style for emojis that have text style as default. EmojiCompat.Config setUseEmojiAsDefaultStyle(     boolean useEmojiAsDefaultStyle,     @Nullable List<Integer> emojiAsDefaultStyleExceptions ) EmojiCompat.Config unregisterInitCallback(@NonNull EmojiCompat.InitCallback initCallback) Unregisters a callback that was added before.

Public constructors

FontRequestEmojiCompatConfig

Added in 1.0.0

public FontRequestEmojiCompatConfig(
    @NonNull Context context,
    @NonNull FontRequest request
)

Parameters
@NonNull Context context	Context instance, cannot be null
@NonNull FontRequest request	FontRequest to fetch the font asynchronously, cannot be null

Public methods

setHandler

Added in 1.0.0

public FontRequestEmojiCompatConfig setHandler(Handler handler)

Sets the custom handler to be used for initialization. Since font fetch take longer time, the metadata loader will fetch the fonts on the background thread. You can pass your own handler for this background fetching. This handler is also used for retrying.

Parameters
Handler handler	A Handler to be used for initialization. Can be null. In case of null, the metadata loader creates own HandlerThread for initialization.

setRetryPolicy

Added in 1.0.0

public FontRequestEmojiCompatConfig setRetryPolicy(FontRequestEmojiCompatConfig.RetryPolicy policy)

Sets the retry policy. {@see RetryPolicy}

Parameters
FontRequestEmojiCompatConfig.RetryPolicy policy	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.