belongs to Maven artifact com.android.support:support-emoji:28.0.0-alpha1
EmojiCompat
public
class
EmojiCompat
extends Object
java.lang.Object | |
↳ | android.support.text.emoji.EmojiCompat |
Main class to keep Android devices up to date with the newest emojis by adding EmojiSpan
s
to a given CharSequence
. It is a singleton class that can be configured using a EmojiCompat.Config
instance.
init(EmojiCompat.Config)
function before it can
process a CharSequence
.
EmojiCompat.init(/* a config instance */);
It is suggested to make the initialization as early as possible in your app. Please check EmojiCompat.Config
for more configuration parameters.
During initialization information about emojis is loaded on a background thread. Before the
EmojiCompat instance is initialized, calls to functions such as process(CharSequence)
will throw an exception. You can use the EmojiCompat.InitCallback
class to be informed about the state of initialization.
After initialization the get()
function can be used to get the configured instance and
the process(CharSequence)
function can be used to update a CharSequence with emoji
EmojiSpans.
CharSequence processedSequence = EmojiCompat.get().process("some string")
Summary
Nested classes | |
---|---|
class |
EmojiCompat.Config
Configuration class for EmojiCompat. |
class |
EmojiCompat.InitCallback
Listener class for the initialization of the EmojiCompat. |
interface |
EmojiCompat.MetadataRepoLoader
Interface to load emoji metadata. |
class |
EmojiCompat.MetadataRepoLoaderCallback
Callback to inform EmojiCompat about the state of the metadata load. |
Constants | |
---|---|
String |
EDITOR_INFO_METAVERSION_KEY
Key in |
String |
EDITOR_INFO_REPLACE_ALL_KEY
Key in |
int |
LOAD_STATE_FAILED
An unrecoverable error occurred during initialization of EmojiCompat. |
int |
LOAD_STATE_LOADING
EmojiCompat is initializing. |
int |
LOAD_STATE_SUCCEEDED
EmojiCompat successfully initialized. |
int |
REPLACE_STRATEGY_ALL
Replace strategy to add |
int |
REPLACE_STRATEGY_DEFAULT
Replace strategy that uses the value given in |
int |
REPLACE_STRATEGY_NON_EXISTENT
Replace strategy to add |
Public methods | |
---|---|
static
EmojiCompat
|
get()
Return singleton EmojiCompat instance. |
String
|
getAssetSignature()
Returns signature for the currently loaded emoji assets. |
int
|
getLoadState()
Returns loading state of the EmojiCompat instance. |
static
boolean
|
handleDeleteSurroundingText(InputConnection inputConnection, Editable editable, int beforeLength, int afterLength, boolean inCodePoints)
Handles deleteSurroundingText commands from |
static
boolean
|
handleOnKeyDown(Editable editable, int keyCode, KeyEvent event)
Handles onKeyDown commands from a |
boolean
|
hasEmojiGlyph(CharSequence sequence)
Returns |
boolean
|
|