रिच कॉन्टेंट पाएं

पहली इमेज. यूनिफ़ाइड एपीआई, एक ही जगह पर इनकमिंग कॉन्टेंट को मैनेज करने की सुविधा देता है. इससे कोई फ़र्क़ नहीं पड़ता कि यूज़र इंटरफ़ेस (यूआई) का कौन-सा तरीका इस्तेमाल किया जा रहा है. जैसे, दबाकर रखने वाले मेन्यू से चिपकाना या खींचकर छोड़ना.

उपयोगकर्ताओं को इमेज, वीडियो, और अन्य कॉन्टेंट पसंद आता है. हालांकि, ऐप्लिकेशन में इस कॉन्टेंट को डालना और एक जगह से दूसरी जगह ले जाना हमेशा आसान नहीं होता. ऐप्लिकेशन को रिच कॉन्टेंट आसानी से मिल सके, इसके लिए Android 12 (एपीआई लेवल 31) में एक यूनीफ़ाइड एपीआई पेश किया गया है. इसकी मदद से, आपका ऐप्लिकेशन किसी भी सोर्स से कॉन्टेंट स्वीकार कर सकता है. जैसे, क्लिपबोर्ड, कीबोर्ड या ड्रैग करके.

यूज़र इंटरफ़ेस (यूआई) कॉम्पोनेंट में OnReceiveContentListener जैसे इंटरफ़ेस अटैच किए जा सकते हैं. साथ ही, किसी भी तरीके से कॉन्टेंट डालने पर कॉलबैक मिल सकता है. कॉलबैक, आपके कोड के लिए एक ही जगह बन जाता है. इससे सादे और स्टाइल वाले टेक्स्ट से लेकर मार्कअप, इमेज, वीडियो, ऑडियो फ़ाइलों वगैरह तक का सारा कॉन्टेंट मैनेज किया जा सकता है.

Android के पिछले वर्शन के साथ काम करने के लिए, यह एपीआई AndroidX में भी उपलब्ध है. यह Core 1.7 और Appcompat 1.4 से शुरू होता है. हमारा सुझाव है कि इस सुविधा को लागू करते समय, इसका इस्तेमाल करें.

खास जानकारी

मौजूदा अन्य एपीआई के साथ, हर यूज़र इंटरफ़ेस (यूआई) मैकेनिज़्म—जैसे कि दबाकर रखने वाला मेन्यू या खींचकर छोड़ने की सुविधा—का अपना एपीआई होता है. इसका मतलब है कि आपको हर एपीआई के साथ अलग-अलग इंटिग्रेट करना होगा. साथ ही, कॉन्टेंट डालने वाले हर मेकेनिज़्म के लिए एक जैसा कोड जोड़ना होगा:

अलग-अलग कार्रवाइयां और उन्हें लागू करने के लिए एपीआई दिखाने वाली इमेज
दूसरी इमेज. पहले, ऐप्लिकेशन कॉन्टेंट डालने के लिए, हर यूज़र इंटरफ़ेस (यूआई) मैकेनिज़्म के लिए अलग-अलग एपीआई लागू करते थे.

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

आसान बनाए गए यूनिफ़ाइड एपीआई को दिखाने वाली इमेज
तीसरी इमेज. यूनीफ़ाइड एपीआई की मदद से, एक ही एपीआई लागू किया जा सकता है. यह एपीआई, यूज़र इंटरफ़ेस (यूआई) के सभी तरीकों के साथ काम करता है.

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

लागू करना

एपीआई, लिसनर इंटरफ़ेस है. इसमें एक ही तरीका है, OnReceiveContentListener. Android प्लैटफ़ॉर्म के पुराने वर्शन के साथ काम करने के लिए, हमारा सुझाव है कि AndroidX Core लाइब्रेरी में मौजूद, इससे मिलता-जुलता OnReceiveContentListener इंटरफ़ेस इस्तेमाल करें.

एपीआई का इस्तेमाल करने के लिए, लिसनर को लागू करें. इसके लिए, यह तय करें कि आपका ऐप्लिकेशन किस तरह के कॉन्टेंट को हैंडल कर सकता है:

Kotlin

object MyReceiver : OnReceiveContentListener {
    val MIME_TYPES = arrayOf("image/*", "video/*")
    
    // ...
    
    override fun onReceiveContent(view: View, payload: ContentInfoCompat): ContentInfoCompat? {
        TODO("Not yet implemented")
    }
}

Java

public class MyReceiver implements OnReceiveContentListener {
     public static final String[] MIME_TYPES = new String[] {"image/*", "video/*"};
     // ...
}

आपके ऐप्लिकेशन पर काम करने वाले सभी कॉन्टेंट MIME टाइप तय करने के बाद, बाकी लिसनर को लागू करें:

Kotlin

class MyReceiver : OnReceiveContentListener {
    override fun onReceiveContent(view: View, contentInfo: ContentInfoCompat): ContentInfoCompat {
        val split = contentInfo.partition { item: ClipData.Item -> item.uri != null }
        val uriContent = split.first
        val remaining = split.second
        if (uriContent != null) {
            // App-specific logic to handle the URI(s) in uriContent.
        }
        // Return anything that your app didn't handle. This preserves the
        // default platform behavior for text and anything else that you aren't
        // implementing custom handling for.
        return remaining
    }

    companion object {
        val MIME_TYPES = arrayOf("image/*", "video/*")
    }
}

Java

 public class MyReceiver implements OnReceiveContentListener {
     public static final String[] MIME_TYPES = new String[] {"image/*", "video/*"};

     @Override
     public ContentInfoCompat onReceiveContent(View view, ContentInfoCompat contentInfo) {
         Pair<ContentInfoCompat, ContentInfoCompat> split = contentInfo.partition(
                 item -> item.getUri() != null);
         ContentInfo uriContent = split.first;
         ContentInfo remaining = split.second;
         if (uriContent != null) {
             // App-specific logic to handle the URI(s) in uriContent.
         }
         // Return anything that your app didn't handle. This preserves the
         // default platform behavior for text and anything else that you aren't
         // implementing custom handling for.
         return remaining;
     }
 }

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

लिसनर को लागू करने के बाद, इसे अपने ऐप्लिकेशन के सही यूज़र इंटरफ़ेस (यूआई) एलिमेंट पर सेट करें:

Kotlin

class MyActivity : Activity() {
    public override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        // ...
        val myInput = findViewById(R.id.my_input)
        ViewCompat.setOnReceiveContentListener(myInput, MyReceiver.MIME_TYPES, MyReceiver())
    }
}

Java

public class MyActivity extends Activity {
     @Override
     public void onCreate(Bundle savedInstanceState) {
         // ...

         AppCompatEditText myInput = findViewById(R.id.my_input);
         ViewCompat.setOnReceiveContentListener(myInput, MyReceiver.MIME_TYPES, new MyReceiver());
     }
}

यूआरआई की अनुमतियां

प्लैटफ़ॉर्म, OnReceiveContentListener को भेजे गए पेलोड में मौजूद किसी भी कॉन्टेंट यूआरआई के लिए, पढ़ने की अनुमतियां अपने-आप देता है और उन्हें वापस लेता है.

आम तौर पर, आपका ऐप्लिकेशन किसी सेवा या गतिविधि में कॉन्टेंट यूआरआई प्रोसेस करता है. प्रोसेसिंग को लंबे समय तक चलाने के लिए, WorkManager का इस्तेमाल करें. इसे लागू करने के लिए, टारगेट सेवा या गतिविधि को अनुमतियां दें. इसके लिए, Intent.setClipData का इस्तेमाल करके कॉन्टेंट पास करें और FLAG_GRANT_READ_URI_PERMISSION फ़्लैग को सेट करें.

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

कस्टम व्यू

अगर आपका ऐप्लिकेशन कस्टम View सबक्लास का इस्तेमाल करता है, तो पक्का करें कि OnReceiveContentListener को बायपास न किया गया हो.

अगर आपकी View क्लास, onCreateInputConnection तरीके को बदलती है, तो InputConnection को कॉन्फ़िगर करने के लिए, Jetpack API InputConnectionCompat.createWrapper का इस्तेमाल करें.

अगर आपकी View क्लास, onTextContextMenuItem तरीके को बदलती है, तो मेन्यू आइटम R.id.paste या R.id.pasteAsPlainText होने पर, सुपर को असाइन करें.

कीबोर्ड इमेज एपीआई से तुलना

OnReceiveContentListener एपीआई को, मौजूदा कीबोर्ड इमेज एपीआई के अगले वर्शन के तौर पर देखा जा सकता है. यह यूनिफ़ाइड एपीआई, कीबोर्ड इमेज एपीआई के साथ-साथ कुछ अतिरिक्त सुविधाओं के साथ काम करता है. डिवाइस और सुविधा के साथ काम करने की क्षमता अलग-अलग होती है. यह इस बात पर निर्भर करती है कि आपने Android SDK से Jetpack लाइब्रेरी या नेटिव एपीआई का इस्तेमाल किया है या नहीं.

पहली टेबल. Jetpack के लिए, इस्तेमाल की जा सकने वाली सुविधाएं और एपीआई लेवल.
कार्रवाई या सुविधा कीबोर्ड इमेज एपीआई के साथ काम करता है यूनिफ़ाइड एपीआई के साथ काम करता है
कीबोर्ड से डालना हां (एपीआई लेवल 13 और इसके बाद के वर्शन) हां (एपीआई लेवल 13 और इसके बाद के वर्शन)
'दबाकर रखें' मेन्यू से चिपकाकर कॉन्टेंट शामिल करना नहीं हां
खींचें और छोड़ें की सुविधा का इस्तेमाल करके इमेज जोड़ना नहीं हां (एपीआई लेवल 24 और उसके बाद के लेवल)
टेबल 2. नेटिव एपीआई के लिए, काम करने वाली सुविधाएं और एपीआई लेवल.
कार्रवाई या सुविधा कीबोर्ड इमेज एपीआई के साथ काम करता है यूनिफ़ाइड एपीआई के साथ काम करता है
कीबोर्ड से डालना हां (एपीआई लेवल 25 और इसके बाद के लेवल) हां (Android 12 और इसके बाद के वर्शन)
'दबाकर रखें' मेन्यू से चिपकाकर कॉन्टेंट शामिल करना नहीं
खींचें और छोड़ें की सुविधा का इस्तेमाल करके इमेज डालना नहीं