इमोजी के साथ काम करने की सुविधा

val config = FontRequestEmojiCompatConfig(...)
        .setReplaceAll(true)
        .setEmojiSpanIndicatorEnabled(true)
        .setEmojiSpanIndicatorColor(Color.GREEN)
        .registerInitCallback(object: EmojiCompat.InitCallback() {
            ...
        })

EmojiCompat.Config config = new FontRequestEmojiCompatConfig(...)
       .setReplaceAll(true)
       .setEmojiSpanIndicatorEnabled(true)
       .setEmojiSpanIndicatorColor(Color.GREEN)
       .registerInitCallback(new InitCallback() {...})

शुरू करने के लिए लिसनर जोड़ना

EmojiCompat और EmojiCompat क्लास, इनिशियलाइज़ेशन कॉलबैक को रजिस्टर करने के लिए, registerInitCallback() और unregisterInitCallback() तरीके उपलब्ध कराती हैं. इन तरीकों का इस्तेमाल करने के लिए, EmojiCompat.InitCallback क्लास का एक इंस्टेंस बनाएं. इन तरीकों को कॉल करें और EmojiCompat.InitCallback क्लास के इंस्टेंस को पास करें. जब EmojiCompat सहायता वाली लाइब्रेरी को शुरू करने की प्रोसेस पूरी हो जाती है, तो EmojiCompat क्लास onInitialized() तरीके को कॉल करती है. अगर लाइब्रेरी शुरू नहीं होती है, तो EmojiCompat क्लास, onFailed() तरीके को कॉल करती है.

किसी भी समय शुरू करने की स्थिति देखने के लिए, getLoadState() विधि को कॉल करें. यह इनमें से कोई एक वैल्यू दिखाता है: LOAD_STATE_LOADING, LOAD_STATE_SUCCEEDED, या LOAD_STATE_FAILED.

AppCompat विजेट के साथ इमोजी का इस्तेमाल करना

अगर AppCompat widgets का इस्तेमाल किया जा रहा है, तो AppCompat widgets से एक्सटेंशन वाले EmojiCompat विजेट इस्तेमाल किए जा सकते हैं.

1. सहायता लाइब्रेरी को डिपेंडेंसी सेक्शन में जोड़ें.

   Groovy

   dependencies {
       ...
       implementation "androidx.emoji:emoji-bundled:$version"
   }

   Kotlin

         dependencies {
             implementation("androidx.emoji:emoji-appcompat:$version")
         }
         

   ग्रूवी

         dependencies {
             implementation "androidx.emoji:emoji-appcompat:$version"
         }
         

2. लेआउट एक्सएमएल में, EmojiCompat AppCompat Widget विजेट का इस्तेमाल करें.

<android.support.text.emoji.widget.EmojiAppCompatTextView
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"/>

<android.support.text.emoji.widget.EmojiAppCompatEditText
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"/>

<android.support.text.emoji.widget.EmojiAppCompatButton
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"/>

बंडल किए गए फ़ॉन्ट का कॉन्फ़िगरेशन

EmojiCompat सहायता लाइब्रेरी, बंडल किए गए फ़ॉन्ट वर्शन में भी उपलब्ध है. इस पैकेज में, एम्बेड किए गए मेटाडेटा वाला फ़ॉन्ट शामिल होता है. इस पैकेज में एक BundledEmojiCompatConfig भी शामिल है, जो मेटाडेटा और फ़ॉन्ट को लोड करने के लिए AssetManager का इस्तेमाल करता है.

ध्यान दें: फ़ॉन्ट का साइज़ कई मेगाबाइट में होता है.

सहायता लाइब्रेरी की डिपेंडेंसी जोड़ना

बंडल किए गए फ़ॉन्ट कॉन्फ़िगरेशन के साथ EmojiCompat सहायता लाइब्रेरी का इस्तेमाल करने के लिए, आपको अपने डेवलपमेंट एनवायरमेंट में अपने ऐप्लिकेशन प्रोजेक्ट की क्लासपथ डिपेंडेंसी में बदलाव करना ज़रूरी है.

अपने ऐप्लिकेशन प्रोजेक्ट में सहायता लाइब्रेरी जोड़ने के लिए:

1. अपने ऐप्लिकेशन की build.gradle फ़ाइल खोलें.
2. सहायता लाइब्रेरी को dependencies सेक्शन में जोड़ें.

dependencies {
    ...
    implementation "androidx.emoji:emoji:28.0.0"
}

dependencies {
    ...
    implementation("androidx.emoji:emoji:28.0.0")
}

EmojiCompat को कॉन्फ़िगर करने के लिए, बंडल किए गए फ़ॉन्ट का इस्तेमाल करना

EmojiCompat को कॉन्फ़िगर करने के लिए, बंडल किए गए फ़ॉन्ट का इस्तेमाल करने के लिए, यह तरीका अपनाएं:

1. EmojiCompat का इंस्टेंस बनाने और Context का इंस्टेंस देने के लिए, BundledEmojiCompatConfig का इस्तेमाल करें.
2. EmojiCompat को शुरू करने के लिए, init() तरीके को कॉल करें और BundledEmojiCompatConfig का इंस्टेंस पास करें.

class MyApplication : Application() {

    override fun onCreate() {
        super.onCreate()
        val config = BundledEmojiCompatConfig(this)
        EmojiCompat.init(config)
    }
}

public class MyApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        EmojiCompat.Config config = new BundledEmojiCompatConfig(this);
        EmojiCompat.init(config);
        ...
    }
}

विजेट के बिना EmojiCompat का इस्तेमाल करना

EmojiCompat, सही इमेज रेंडर करने के लिए EmojiSpan का इस्तेमाल करता है. इसलिए, इसे किसी भी दिए गए CharSequence को EmojiSpans के साथ Spanned इंस्टेंस में बदलना होगा. EmojiCompat क्लास, EmojiSpans की मदद से CharSequences को Spanned इंस्टेंस में बदलने का तरीका उपलब्ध कराती है. इस तरीके का इस्तेमाल करके, रॉ स्ट्रिंग के बजाय प्रोसेस किए गए इंस्टेंस को प्रोसेस और कैश किया जा सकता है. इससे, आपके ऐप्लिकेशन की परफ़ॉर्मेंस बेहतर होती है.

val processed = EmojiCompat.get().process("neutral face \uD83D\uDE10")

CharSequence processed = EmojiCompat.get().process("neutral face \uD83D\uDE10");

IME के लिए EmojiCompat का इस्तेमाल करना

EmojiCompat की सहायता लाइब्रेरी का इस्तेमाल करके, कीबोर्ड उन इमोजी को रेंडर कर सकते हैं जिनका इस्तेमाल, उस ऐप्लिकेशन में किया जा सकता है जिससे इंटरैक्ट किया जा रहा है. IMEs, hasEmojiGlyph() तरीके का इस्तेमाल करके यह पता लगा सकते हैं कि EmojiCompat, इमोजी को रेंडर कर सकता है या नहीं. यह तरीका, किसी इमोजी का CharSequence लेता है और अगर EmojiCompat उस इमोजी का पता लगाकर उसे रेंडर कर सकता है, तो true दिखाता है.

कीबोर्ड, EmojiCompat की सहायता लाइब्रेरी का वह वर्शन भी देख सकता है जो ऐप्लिकेशन के साथ काम करता है. इससे यह तय किया जा सकता है कि पैलेट में किस इमोजी को रेंडर करना है. वर्शन की जांच करने के लिए, अगर उपलब्ध हो, तो कीबोर्ड को यह देखना होगा कि EditorInfo.extras बंडल में ये बटन मौजूद हैं या नहीं:

• EDITOR_INFO_METAVERSION_KEY

अगर बंडल में कुंजी मौजूद है, तो वैल्यू से उस इमोजी मेटाडेटा के वर्शन का पता चलता है जिसका इस्तेमाल ऐप्लिकेशन करता है. अगर यह कुंजी मौजूद नहीं है, तो इसका मतलब है कि ऐप्लिकेशन EmojiCompat का इस्तेमाल नहीं कर रहा है.

• EDITOR_INFO_REPLACE_ALL_KEY

अगर पासकोड मौजूद है और उसे true पर सेट किया गया है, तो इससे पता चलता है कि ऐप्लिकेशन ने SetReplaceAll() तरीके को कॉल किया है. EmojiCompat कॉन्फ़िगरेशन के बारे में ज़्यादा जानकारी के लिए, कॉन्फ़िगरेशन के विकल्प सेक्शन देखें.

EditorInfo.extras बंडल में कुंजियां मिलने के बाद, कीबोर्ड hasEmojiGlyph() वाला तरीका इस्तेमाल कर सकता है. इसमें metadataVersion, EDITOR_INFO_METAVERSION_KEY की वैल्यू होती है. इसकी मदद से यह पता लगाया जा सकता है कि ऐप्लिकेशन किसी खास इमोजी को रेंडर कर सकता है या नहीं.

कस्टम विजेट के साथ EmojiCompat का इस्तेमाल करना

अपने ऐप्लिकेशन में CharSequence को प्रीप्रोसेस करने के लिए, process() तरीके का इस्तेमाल कभी भी किया जा सकता है. साथ ही, इसे किसी भी ऐसे विजेट में जोड़ा जा सकता है जो Spanned इंस्टेंस को रेंडर कर सकता है. उदाहरण के लिए, TextView. इसके अलावा, EmojiCompat ये विजेट हेल्पर क्लास उपलब्ध कराता है, ताकि आप कम से कम मेहनत करके, अपने कस्टम विजेट को इमोजी की सुविधा से बेहतर बना सकें.

• EmojiTextViewHelper
• EmojiEditTextHelper

TextView का सैंपल

Kotlin

class MyTextView(context: Context) : AppCompatTextView(context) {

    private val emojiTextViewHelper: EmojiTextViewHelper by lazy(LazyThreadSafetyMode.NONE) {
        EmojiTextViewHelper(this).apply {
            updateTransformationMethod()
        }
    }

    override fun setFilters(filters: Array<InputFilter>) {
        super.setFilters(emojiTextViewHelper.getFilters(filters))
    }

    override fun setAllCaps(allCaps: Boolean) {
        super.setAllCaps(allCaps)
        emojiTextViewHelper.setAllCaps(allCaps)
    }
}

Java

public class MyTextView extends AppCompatTextView {
   ...
   public MyTextView(Context context) {
       super(context);
       init();
   }
   ...
   private void init() {
       getEmojiTextViewHelper().updateTransformationMethod();
   }

   @Override
   public void setFilters(InputFilter[] filters) {
       super.setFilters(getEmojiTextViewHelper().getFilters(filters));
   }

   @Override
   public void setAllCaps(boolean allCaps) {
       super.setAllCaps(allCaps);
       getEmojiTextViewHelper().setAllCaps(allCaps);
   }

   private EmojiTextViewHelper getEmojiTextViewHelper() {
       ...
   }
}

EditText का सैंपल

Kotlin

class MyEditText(context: Context) : AppCompatEditText(context) {

    private val emojiEditTextHelper: EmojiEditTextHelper by lazy(LazyThreadSafetyMode.NONE) {
        EmojiEditTextHelper(this).also {
            super.setKeyListener(it.getKeyListener(keyListener))
        }
    }

    override fun setKeyListener(input: KeyListener?) {
        input?.also {
            super.setKeyListener(emojiEditTextHelper.getKeyListener(it))
        }
    }

    override fun onCreateInputConnection(outAttrs: EditorInfo): InputConnection {
        val inputConnection: InputConnection = super.onCreateInputConnection(outAttrs)
        return emojiEditTextHelper.onCreateInputConnection(
                inputConnection,
                outAttrs
        ) as InputConnection
    }
}

Java

public class MyEditText extends AppCompatEditText {
   ...
   public MyEditText(Context context) {
       super(context);
       init();
   }
   ...
   private void init() {
       super.setKeyListener(getEmojiEditTextHelper().getKeyListener(getKeyListener()));
   }

   @Override
   public void setKeyListener(android.text.method.KeyListener keyListener) {
       super.setKeyListener(getEmojiEditTextHelper().getKeyListener(keyListener));
   }

   @Override
   public InputConnection onCreateInputConnection(EditorInfo outAttrs) {
       InputConnection inputConnection = super.onCreateInputConnection(outAttrs);
       return getEmojiEditTextHelper().onCreateInputConnection(inputConnection, outAttrs);
   }

   private EmojiEditTextHelper getEmojiEditTextHelper() {
       ...
   }
}

अक्सर पूछे जाने वाले सवाल

• मैं फ़ॉन्ट डाउनलोड कैसे शुरू करूं?

अगर डिवाइस पर इमोजी फ़ॉन्ट मौजूद नहीं हैं, तो इन्हें पहली बार अनुरोध करने पर डाउनलोड किया जाता है. डाउनलोड शेड्यूलिंग की जानकारी, ऐप्लिकेशन के लिए साफ़ तौर पर दिखती है.

• इसे शुरू होने में कितना समय लगता है?

फ़ॉन्ट डाउनलोड होने के बाद, EmojiCompat को शुरू करने में करीब 150 मिलीसेकंड लगते हैं.

• EmojiCompat सहायता लाइब्रेरी कितनी मेमोरी का इस्तेमाल करती है?

फ़िलहाल, इमोजी ढूंढने के लिए डेटा स्ट्रक्चर, ऐप्लिकेशन की स्मृति में लोड किया जाता है और इसमें करीब 200 केबी का इस्तेमाल होता है.

• क्या कस्टम TextView के लिए इमोजीकॉम्पैट का इस्तेमाल किया जा सकता है?

हां. इमोजीकंपैट, कस्टम विजेट के लिए हेल्पर क्लास उपलब्ध कराता है. किसी दी गई स्ट्रिंग को पहले से प्रोसेस करके, उसे Spanned में बदला भी जा सकता है. विजेट हेल्पर क्लास के बारे में ज़्यादा जानकारी के लिए, कस्टम विजेट के साथ इमोजी का इस्तेमाल करना सेक्शन देखें.

• Android 4.4 (एपीआई लेवल 19) या इससे पहले के वर्शन पर काम करने वाले डिवाइसों पर, लेआउट एक्सएमएल में विजेट जोड़ने पर क्या होगा?

EmojiCompat सहायता लाइब्रेरी या उसके विजेट को उन ऐप्लिकेशन में शामिल किया जा सकता है जो Android 4.4 (एपीआई लेवल 19) या इससे पहले के वर्शन पर काम करने वाले डिवाइसों पर काम करते हैं. हालांकि, अगर कोई डिवाइस एपीआई लेवल 19 से पहले के Android वर्शन पर चल रहा है, तो EmojiCompat और इसके विजेट "कोई कार्रवाई नहीं" की स्थिति में हैं. इसका मतलब है कि EmojiTextView, एक सामान्य TextView के जैसे ही काम करता है. EmojiCompat इंस्टेंस; init() तरीका कॉल करने पर, यह तुरंत LOAD_STATE_SUCCEEDED स्थिति में आ जाता है.

अन्य संसाधन

EmojiCompat लाइब्रेरी का इस्तेमाल करने के बारे में ज़्यादा जानकारी के लिए, EmojiCompat पर जाएं.