कॉपी करें और चिपकाएं

Compose को आज़माएं

Jetpack Compose, Android के लिए सुझाई गई यूज़र इंटरफ़ेस (यूआई) टूलकिट है. Compose में कॉपी और पेस्ट करने का तरीका जानें.

कॉपी करना और चिपकाना →

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

फ़्रेमवर्क का कुछ हिस्सा, कॉन्टेंट देने वाले का इस्तेमाल करता है. इसलिए, इस दस्तावेज़ में यह माना गया है कि आपको Android Content Provider API के बारे में कुछ जानकारी है. इसके बारे में कॉन्टेंट देने वाले में बताया गया है.

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

Android 12L (एपीआई लेवल 32) और इससे पहले के वर्शन में, कॉपी करते समय उपयोगकर्ताओं को मैन्युअल तरीके से सुझाव/राय दें या शिकायत करें. इस दस्तावेज़ में, इसके लिए सुझाव देखें.

क्लिपबोर्ड फ़्रेमवर्क

क्लिपबोर्ड फ़्रेमवर्क का इस्तेमाल करते समय, डेटा को क्लिप ऑब्जेक्ट में डालें. इसके बाद, क्लिप ऑब्जेक्ट को सिस्टम-वाइड क्लिपबोर्ड पर डालें. क्लिप ऑब्जेक्ट को इन तीन में से किसी एक फ़ॉर्म में लिया जा सकता है:

टेक्स्ट

टेक्स्ट स्ट्रिंग. स्ट्रिंग को सीधे क्लिप ऑब्जेक्ट में डालें. इसके बाद, उसे क्लिपबोर्ड पर डालें. स्ट्रिंग को चिपकाने के लिए, क्लिपबोर्ड से क्लिप ऑब्जेक्ट लें और स्ट्रिंग को अपने ऐप्लिकेशन के स्टोरेज में कॉपी करें.

यूआरआई

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

प्रयोजन

Intent. इससे, ऐप्लिकेशन के शॉर्टकट कॉपी किए जा सकते हैं. डेटा कॉपी करने के लिए, Intent बनाएं, उसे क्लिप ऑब्जेक्ट में डालें, और क्लिप ऑब्जेक्ट को क्लिपबोर्ड पर डालें. डेटा चिपकाने के लिए, क्लिप ऑब्जेक्ट को पाएं. इसके बाद, Intent ऑब्जेक्ट को अपने ऐप्लिकेशन के मेमोरी एरिया में कॉपी करें.

क्लिपबोर्ड में एक बार में सिर्फ़ एक क्लिप ऑब्जेक्ट सेव किया जा सकता है. जब कोई ऐप्लिकेशन, क्लिपबोर्ड पर कोई क्लिप ऑब्जेक्ट डालता है, तो पिछला क्लिप ऑब्जेक्ट गायब हो जाता है.

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

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

क्लिपबोर्ड क्लास

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

ClipboardManager

Android सिस्टम क्लिपबोर्ड को ग्लोबल ClipboardManager क्लास से दिखाया जाता है. इस क्लास को सीधे इंस्टैंशिएट न करें. इसके बजाय, getSystemService(CLIPBOARD_SERVICE) को शुरू करके इसका रेफ़रंस पाएं.

ClipData, ClipData.Item, और ClipDescription

क्लिपबोर्ड में डेटा जोड़ने के लिए, एक ClipData ऑब्जेक्ट बनाएं. इसमें डेटा और उसकी जानकारी शामिल होनी चाहिए. क्लिपबोर्ड में एक बार में एक ही ClipData सेव किया जा सकता है. ClipData में एक ClipDescription ऑब्जेक्ट और एक या उससे ज़्यादा ClipData.Item ऑब्जेक्ट होते हैं.

ClipDescription ऑब्जेक्ट में क्लिप का मेटाडेटा होता है. खास तौर पर, इसमें क्लिप के डेटा के लिए उपलब्ध एमआईएमई टाइप का कलेक्शन होता है. इसके अलावा, Android 12 (एपीआई लेवल 31) और इसके बाद के वर्शन पर, मेटाडेटा में यह जानकारी शामिल होती है कि ऑब्जेक्ट में स्टाइल वाला टेक्स्ट और ऑब्जेक्ट में मौजूद टेक्स्ट का टाइप शामिल है या नहीं. जब क्लिपबोर्ड पर कोई क्लिप डाली जाती है, तो यह जानकारी पेस्ट करने वाले ऐप्लिकेशन के लिए उपलब्ध होती है. इससे यह पता चलता है कि वे क्लिप डेटा को हैंडल कर सकते हैं या नहीं.

ClipData.Item ऑब्जेक्ट में टेक्स्ट, यूआरआई या इंटेंट डेटा होता है:

टेक्स्ट

CharSequence.

यूआरआई

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

प्रयोजन

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

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

ClipData convenience methods

ClipData क्लास, एक ClipData.Item ऑब्जेक्ट और एक सामान्य ClipDescription ऑब्जेक्ट के साथ ClipData ऑब्जेक्ट बनाने के लिए, स्टैटिक कन्वीनियंस मेथड उपलब्ध कराती है:

newPlainText(label, text)

यह ClipData ऑब्जेक्ट दिखाता है, जिसके एक ClipData.Item ऑब्जेक्ट में टेक्स्ट स्ट्रिंग होती है. ClipDescription ऑब्जेक्ट का लेबल, label पर सेट है. ClipDescription में मौजूद सिंगल एमआईएमई टाइप, MIMETYPE_TEXT_PLAIN है.

टेक्स्ट स्ट्रिंग से क्लिप बनाने के लिए, newPlainText() का इस्तेमाल करें.

newUri(resolver, label, URI)

यह एक ClipData ऑब्जेक्ट दिखाता है, जिसके सिंगल ClipData.Item ऑब्जेक्ट में यूआरआई होता है. ClipDescription ऑब्जेक्ट का लेबल, label पर सेट है. अगर यूआरआई एक कॉन्टेंट यूआरआई है, यानी कि अगर Uri.getScheme(), content: दिखाता है, तो यह तरीका resolver में दिए गए ContentResolver ऑब्जेक्ट का इस्तेमाल करता है. इससे कॉन्टेंट देने वाले से उपलब्ध एमआईएमई टाइप को वापस लाया जाता है. इसके बाद, यह उन्हें ClipDescription में सेव करता है. ऐसे यूआरआई के लिए जो content: यूआरआई नहीं है, यह तरीका एमआईएमई टाइप को MIMETYPE_TEXT_URILIST पर सेट करता है.

किसी यूआरआई से क्लिप बनाने के लिए, newUri() का इस्तेमाल करें. खास तौर पर, content: यूआरआई से.

newIntent(label, intent)

यह एक ClipData ऑब्जेक्ट दिखाता है, जिसके एक ClipData.Item ऑब्जेक्ट में Intent होता है. ClipDescription ऑब्जेक्ट का लेबल, label पर सेट है. एमआईएमई टाइप को MIMETYPE_TEXT_INTENT पर सेट किया गया है.

Intent ऑब्जेक्ट से क्लिप बनाने के लिए, newIntent() का इस्तेमाल करें.

क्लिपबोर्ड के डेटा को टेक्स्ट में बदलें

अगर आपका ऐप्लिकेशन सिर्फ़ टेक्स्ट को हैंडल करता है, तो भी क्लिपबोर्ड से नॉन-टेक्स्ट डेटा को कॉपी किया जा सकता है. इसके लिए, आपको ClipData.Item.coerceToText() तरीके का इस्तेमाल करके, डेटा को टेक्स्ट में बदलना होगा.

यह तरीका, ClipData.Item में मौजूद डेटा को टेक्स्ट में बदलता है और CharSequence दिखाता है. ClipData.Item.coerceToText() से मिलने वाली वैल्यू, ClipData.Item में मौजूद डेटा के फ़ॉर्मैट पर आधारित होती है:

टेक्स्ट

अगर ClipData.Item टेक्स्ट है, यानी कि अगर getText() शून्य नहीं है, तो coerceToText() टेक्स्ट दिखाता है.

यूआरआई

अगर ClipData.Item एक यूआरआई है, यानी कि अगर getUri() शून्य नहीं है, तो coerceToText() इसे कॉन्टेंट यूआरआई के तौर पर इस्तेमाल करने की कोशिश करता है.

• अगर यूआरआई एक कॉन्टेंट यूआरआई है और प्रोवाइडर टेक्स्ट स्ट्रीम दिखा सकता है, तो coerceToText() एक टेक्स्ट स्ट्रीम दिखाता है.
• अगर यूआरआई एक कॉन्टेंट यूआरआई है, लेकिन सेवा देने वाली कंपनी टेक्स्ट स्ट्रीम उपलब्ध नहीं कराती है, तो coerceToText() यूआरआई का प्रज़ेंटेशन दिखाता है. यह रिप्रज़ेंटेशन, Uri.toString() से मिलने वाले रिस्पॉन्स जैसा ही होता है.
• अगर यूआरआई, कॉन्टेंट यूआरआई नहीं है, तो coerceToText() यूआरआई का प्रज़ेंटेशन दिखाता है. यह रिस्पॉन्स, Uri.toString() से मिले रिस्पॉन्स जैसा ही होता है.

प्रयोजन

अगर ClipData.Item एक Intent है—यानी कि अगर getIntent() शून्य नहीं है—तो coerceToText() इसे इंटेंट यूआरआई में बदल देता है और उसे दिखाता है. यह रिस्पॉन्स, Intent.toUri(URI_INTENT_SCHEME) से मिले रिस्पॉन्स जैसा ही होता है.

क्लिपबोर्ड फ़्रेमवर्क के बारे में इमेज 2 में बताया गया है. डेटा कॉपी करने के लिए, कोई ऐप्लिकेशन ClipboardManager ग्लोबल क्लिपबोर्ड पर ClipData ऑब्जेक्ट डालता है. ClipData में एक या इससे ज़्यादा ClipData.Item ऑब्जेक्ट और एक ClipDescription ऑब्जेक्ट होता है. डेटा चिपकाने के लिए, कोई ऐप्लिकेशन ClipData को हासिल करता है, ClipDescription से उसका एमआईएमई टाइप हासिल करता है, और ClipData.Item या ClipData.Item से रेफ़र किए गए कॉन्टेंट प्रोवाइडर से डेटा हासिल करता है.

क्लिपबोर्ड पर कॉपी करना

क्लिपबोर्ड पर डेटा कॉपी करने के लिए, ग्लोबल ClipboardManager ऑब्जेक्ट का हैंडल पाएं, ClipData ऑब्जेक्ट बनाएं, और उसमें ClipDescription और एक या उससे ज़्यादा ClipData.Item ऑब्जेक्ट जोड़ें. इसके बाद, तैयार किए गए ClipData ऑब्जेक्ट को ClipboardManager ऑब्जेक्ट में जोड़ें. इस बारे में यहां दी गई प्रोसेस में ज़्यादा जानकारी दी गई है:

1. अगर कॉन्टेंट यूआरआई का इस्तेमाल करके डेटा कॉपी किया जा रहा है, तो कॉन्टेंट देने वाला सेट अप करें.
2. सिस्टम क्लिपबोर्ड को ऐक्सेस करना:

   Kotlin

   when(menuItem.itemId) {
       ...
       R.id.menu_copy -> { // if the user selects copy
           // Gets a handle to the clipboard service.
           val clipboard = getSystemService(Context.CLIPBOARD_SERVICE) as ClipboardManager
       }
   }

   Java

   ...
   // If the user selects copy.
   case R.id.menu_copy:
   
   // Gets a handle to the clipboard service.
   ClipboardManager clipboard = (ClipboardManager)
           getSystemService(Context.CLIPBOARD_SERVICE);

3. डेटा को किसी नए ClipData ऑब्जेक्ट में कॉपी करें:

   • टेक्स्ट के लिए

     Kotlin

     // Creates a new text clip to put on the clipboard.
     val clip: ClipData = ClipData.newPlainText("simple text", "Hello, World!")

     Java

     // Creates a new text clip to put on the clipboard.
     ClipData clip = ClipData.newPlainText("simple text", "Hello, World!");

   • यूआरआई के लिए

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

     Kotlin

     // Creates a Uri using a base Uri and a record ID based on the contact's last
     // name. Declares the base URI string.
     const val CONTACTS = "content://com.example.contacts"
     
     // Declares a path string for URIs, used to copy data.
     const val COPY_PATH = "/copy"
     
     // Declares the Uri to paste to the clipboard.
     val copyUri: Uri = Uri.parse("$CONTACTS$COPY_PATH/$lastName")
     ...
     // Creates a new URI clip object. The system uses the anonymous
     // getContentResolver() object to get MIME types from provider. The clip object's
     // label is "URI", and its data is the Uri previously created.
     val clip: ClipData = ClipData.newUri(contentResolver, "URI", copyUri)

     Java

     // Creates a Uri using a base Uri and a record ID based on the contact's last
     // name. Declares the base URI string.
     private static final String CONTACTS = "content://com.example.contacts";
     
     // Declares a path string for URIs, used to copy data.
     private static final String COPY_PATH = "/copy";
     
     // Declares the Uri to paste to the clipboard.
     Uri copyUri = Uri.parse(CONTACTS + COPY_PATH + "/" + lastName);
     ...
     // Creates a new URI clip object. The system uses the anonymous
     // getContentResolver() object to get MIME types from provider. The clip object's
     // label is "URI", and its data is the Uri previously created.
     ClipData clip = ClipData.newUri(getContentResolver(), "URI", copyUri);

   • किसी इंटेंट के लिए

     यह स्निपेट किसी ऐप्लिकेशन के लिए Intent बनाता है और फिर उसे क्लिप ऑब्जेक्ट में डालता है:

     Kotlin

     // Creates the Intent.
     val appIntent = Intent(this, com.example.demo.myapplication::class.java)
     ...
     // Creates a clip object with the Intent in it. Its label is "Intent"
     // and its data is the Intent object created previously.
     val clip: ClipData = ClipData.newIntent("Intent", appIntent)

     Java

     // Creates the Intent.
     Intent appIntent = new Intent(this, com.example.demo.myapplication.class);
     ...
     // Creates a clip object with the Intent in it. Its label is "Intent"
     // and its data is the Intent object created previously.
     ClipData clip = ClipData.newIntent("Intent", appIntent);

4. क्लिपबोर्ड पर नया क्लिप ऑब्जेक्ट डालें:

   Kotlin

   // Set the clipboard's primary clip.
   clipboard.setPrimaryClip(clip)

   Java

   // Set the clipboard's primary clip.
   clipboard.setPrimaryClip(clip);

क्लिपबोर्ड पर कॉपी करते समय सुझाव/राय देना या शिकायत करना

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

Android 13 से, क्लिपबोर्ड में कॉन्टेंट जोड़े जाने पर, सिस्टम एक स्टैंडर्ड विज़ुअल कन्फ़र्मेशन दिखाता है. पुष्टि करने की नई सुविधा से ये काम किए जा सकते हैं:

• कॉन्टेंट के कॉपी होने की पुष्टि करता है.
• कॉपी किए गए कॉन्टेंट की झलक दिखाता है.

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

डुप्लीकेट सूचनाएं मिलने से बचना

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

जानकारी को डुप्लीकेट होने से बचाने के लिए, हमारा सुझाव है कि Android 13 और इसके बाद के वर्शन के लिए, इन-ऐप्लिकेशन कॉपी के बाद दिखने वाले टोस्ट या स्नैकबार हटाएं.

इसे लागू करने का तरीका यहां बताया गया है:

fun textCopyThenPost(textCopied:String) {
    val clipboardManager = getSystemService(CLIPBOARD_SERVICE) as ClipboardManager
    // When setting the clipboard text.
    clipboardManager.setPrimaryClip(ClipData.newPlainText   ("", textCopied))
    // Only show a toast for Android 12 and lower.
    if (Build.VERSION.SDK_INT <= Build.VERSION_CODES.S_V2)
        Toast.makeText(context, “Copied”, Toast.LENGTH_SHORT).show()
}

क्लिपबोर्ड में संवेदनशील कॉन्टेंट जोड़ना

अगर आपका ऐप्लिकेशन उपयोगकर्ताओं को क्लिपबोर्ड पर संवेदनशील कॉन्टेंट कॉपी करने की अनुमति देता है, जैसे कि पासवर्ड या क्रेडिट कार्ड की जानकारी, तो आपको ClipboardManager.setPrimaryClip() को कॉल करने से पहले, ClipData में ClipDescription में एक फ़्लैग जोड़ना होगा. इस फ़्लैग को जोड़ने से, Android 13 और इसके बाद के वर्शन में कॉपी किए गए कॉन्टेंट की विज़ुअल पुष्टि में संवेदनशील कॉन्टेंट नहीं दिखता.

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

// If your app is compiled with the API level 33 SDK or higher.
clipData.apply {
    description.extras = PersistableBundle().apply {
        putBoolean(ClipDescription.EXTRA_IS_SENSITIVE, true)
    }
}

// If your app is compiled with a lower SDK.
clipData.apply {
    description.extras = PersistableBundle().apply {
        putBoolean("android.content.extra.IS_SENSITIVE", true)
    }
}

क्लिपबोर्ड से चिपकाना

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

सादा टेक्स्ट चिपकाना

सामान्य टेक्स्ट चिपकाने के लिए, ग्लोबल क्लिपबोर्ड का इस्तेमाल करें और पुष्टि करें कि यह सामान्य टेक्स्ट दिखा सकता है. इसके बाद, क्लिप ऑब्जेक्ट को पाएं और getText() का इस्तेमाल करके, उसके टेक्स्ट को अपने स्टोरेज में कॉपी करें. इसके लिए, यहां दी गई प्रोसेस अपनाएं:

1. getSystemService(CLIPBOARD_SERVICE) का इस्तेमाल करके, ग्लोबल ClipboardManager ऑब्जेक्ट पाएं. साथ ही, चिपकाए गए टेक्स्ट को सेव करने के लिए, एक ग्लोबल वैरिएबल तय करें:

   Kotlin

   var clipboard = getSystemService(Context.CLIPBOARD_SERVICE) as ClipboardManager
   var pasteData: String = ""

   Java

   ClipboardManager clipboard = (ClipboardManager) getSystemService(Context.CLIPBOARD_SERVICE);
   String pasteData = "";

2. यह तय करें कि आपको मौजूदा गतिविधि में "चिपकाएं" विकल्प को चालू करना है या बंद करना है. पुष्टि करें कि क्लिपबोर्ड में कोई क्लिप मौजूद है और क्लिप में मौजूद डेटा टाइप को हैंडल किया जा सकता है:

   Kotlin

   // Gets the ID of the "paste" menu item.
   val pasteItem: MenuItem = menu.findItem(R.id.menu_paste)
   
   // If the clipboard doesn't contain data, disable the paste menu item.
   // If it does contain data, decide whether you can handle the data.
   pasteItem.isEnabled = when {
       !clipboard.hasPrimaryClip() -> {
           false
       }
       !(clipboard.primaryClipDescription.hasMimeType(MIMETYPE_TEXT_PLAIN)) -> {
           // Disables the paste menu item, since the clipboard has data but it
           // isn't plain text.
           false
       }
       else -> {
           // Enables the paste menu item, since the clipboard contains plain text.
           true
       }
   }

   Java

   // Gets the ID of the "paste" menu item.
   MenuItem pasteItem = menu.findItem(R.id.menu_paste);
   
   // If the clipboard doesn't contain data, disable the paste menu item.
   // If it does contain data, decide whether you can handle the data.
   if (!(clipboard.hasPrimaryClip())) {
   
       pasteItem.setEnabled(false);
   
   } else if (!(clipboard.getPrimaryClipDescription().hasMimeType(MIMETYPE_TEXT_PLAIN))) {
   
       // Disables the paste menu item, since the clipboard has data but
       // it isn't plain text.
       pasteItem.setEnabled(false);
   } else {
   
       // Enables the paste menu item, since the clipboard contains plain text.
       pasteItem.setEnabled(true);
   }

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

   Kotlin

   when (menuItem.itemId) {
       ...
       R.id.menu_paste -> {    // Responds to the user selecting "paste".
           // Examines the item on the clipboard. If getText() doesn't return null,
           // the clip item contains the text. Assumes that this application can only
           // handle one item at a time.
           val item = clipboard.primaryClip.getItemAt(0)
   
           // Gets the clipboard as text.
           pasteData = item.text
   
           return if (pasteData != null) {
               // If the string contains data, then the paste operation is done.
               true
           } else {
               // The clipboard doesn't contain text. If it contains a URI,
               // attempts to get data from it.
               val pasteUri: Uri? = item.uri
   
               if (pasteUri != null) {
                   // If the URI contains something, try to get text from it.
   
                   // Calls a routine to resolve the URI and get data from it.
                   // This routine isn't presented here.
                   pasteData = resolveUri(pasteUri)
                   true
               } else {
   
                   // Something is wrong. The MIME type was plain text, but the
                   // clipboard doesn't contain text or a Uri. Report an error.
                   Log.e(TAG,"Clipboard contains an invalid data type")
                   false
               }
           }
       }
   }

   Java

   // Responds to the user selecting "paste".
   case R.id.menu_paste:
   
   // Examines the item on the clipboard. If getText() does not return null,
   // the clip item contains the text. Assumes that this application can only
   // handle one item at a time.
    ClipData.Item item = clipboard.getPrimaryClip().getItemAt(0);
   
   // Gets the clipboard as text.
   pasteData = item.getText();
   
   // If the string contains data, then the paste operation is done.
   if (pasteData != null) {
       return true;
   
   // The clipboard doesn't contain text. If it contains a URI, attempts to get
   // data from it.
   } else {
       Uri pasteUri = item.getUri();
   
       // If the URI contains something, try to get text from it.
       if (pasteUri != null) {
   
           // Calls a routine to resolve the URI and get data from it.
           // This routine isn't presented here.
           pasteData = resolveUri(Uri);
           return true;
       } else {
   
           // Something is wrong. The MIME type is plain text, but the
           // clipboard doesn't contain text or a Uri. Report an error.
           Log.e(TAG, "Clipboard contains an invalid data type");
           return false;
       }
   }

कॉन्टेंट यूआरआई से डेटा चिपकाना

अगर ClipData.Item ऑब्जेक्ट में कोई कॉन्टेंट यूआरआई मौजूद है और आपको लगता है कि आपके पास उसके किसी एमआईएमई टाइप को मैनेज करने की सुविधा है, तो एक ContentResolver बनाएं. इसके बाद, डेटा वापस पाने के लिए, कॉन्टेंट देने वाले के सही तरीके को कॉल करें.

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

1. एमआईएमई टाइप को शामिल करने के लिए, ग्लोबल वैरिएबल का एलान करें:

   Kotlin

   // Declares a MIME type constant to match against the MIME types offered
   // by the provider.
   const val MIME_TYPE_CONTACT = "vnd.android.cursor.item/vnd.example.contact"

   Java

   // Declares a MIME type constant to match against the MIME types offered by
   // the provider.
   public static final String MIME_TYPE_CONTACT = "vnd.android.cursor.item/vnd.example.contact";

2. ग्लोबल क्लिपबोर्ड पाएं. कॉन्टेंट रिज़ॉल्वर भी पाएं, ताकि आप कॉन्टेंट देने वाले को ऐक्सेस कर सकें:

   Kotlin

   // Gets a handle to the Clipboard Manager.
   val clipboard = getSystemService(Context.CLIPBOARD_SERVICE) as ClipboardManager
   
   // Gets a content resolver instance.
   val cr = contentResolver

   Java

   // Gets a handle to the Clipboard Manager.
   ClipboardManager clipboard = (ClipboardManager) getSystemService(Context.CLIPBOARD_SERVICE);
   
   // Gets a content resolver instance.
   ContentResolver cr = getContentResolver();

3. क्लिपबोर्ड से प्राइमरी क्लिप पाएं और उसके कॉन्टेंट को यूआरआई के तौर पर पाएं:

   Kotlin

   // Gets the clipboard data from the clipboard.
   val clip: ClipData? = clipboard.primaryClip
   
   clip?.run {
   
       // Gets the first item from the clipboard data.
       val item: ClipData.Item = getItemAt(0)
   
       // Tries to get the item's contents as a URI.
       val pasteUri: Uri? = item.uri

   Java

   // Gets the clipboard data from the clipboard.
   ClipData clip = clipboard.getPrimaryClip();
   
   if (clip != null) {
   
       // Gets the first item from the clipboard data.
       ClipData.Item item = clip.getItemAt(0);
   
       // Tries to get the item's contents as a URI.
       Uri pasteUri = item.getUri();

4. getType(Uri) को कॉल करके, यह जांच करें कि यूआरआई, कॉन्टेंट यूआरआई है या नहीं. अगर Uri किसी मान्य कॉन्टेंट प्रोवाइडर पर ले जाने वाला यूआरआई नहीं है, तो यह तरीका शून्य दिखाता है.

   Kotlin

       // If the clipboard contains a URI reference...
       pasteUri?.let {
   
           // ...is this a content URI?
           val uriMimeType: String? = cr.getType(it)

   Java

       // If the clipboard contains a URI reference...
       if (pasteUri != null) {
   
           // ...is this a content URI?
           String uriMimeType = cr.getType(pasteUri);

5. यह जांच करना कि कॉन्टेंट देने वाला, ऐसे एमआईएमई टाइप के साथ काम करता है या नहीं जिसे ऐप्लिकेशन समझता है. अगर ऐसा होता है, तो डेटा पाने के लिए ContentResolver.query() को कॉल करें. रिटर्न वैल्यू एक Cursor है.

   Kotlin

           // If the return value isn't null, the Uri is a content Uri.
           uriMimeType?.takeIf {
   
               // Does the content provider offer a MIME type that the current
               // application can use?
               it == MIME_TYPE_CONTACT
           }?.apply {
   
               // Get the data from the content provider.
               cr.query(pasteUri, null, null, null, null)?.use { pasteCursor ->
   
                   // If the Cursor contains data, move to the first record.
                   if (pasteCursor.moveToFirst()) {
   
                       // Get the data from the Cursor here.
                       // The code varies according to the format of the data model.
                   }
   
                   // Kotlin `use` automatically closes the Cursor.
               }
           }
       }
   }

   Java

           // If the return value isn't null, the Uri is a content Uri.
           if (uriMimeType != null) {
   
               // Does the content provider offer a MIME type that the current
               // application can use?
               if (uriMimeType.equals(MIME_TYPE_CONTACT)) {
   
                   // Get the data from the content provider.
                   Cursor pasteCursor = cr.query(uri, null, null, null, null);
   
                   // If the Cursor contains data, move to the first record.
                   if (pasteCursor != null) {
                       if (pasteCursor.moveToFirst()) {
   
                       // Get the data from the Cursor here.
                       // The code varies according to the format of the data model.
                       }
                   }
   
                   // Close the Cursor.
                   pasteCursor.close();
                }
            }
        }
   }

इंटेंट चिपकाना

किसी इंटेंट को चिपकाने के लिए, पहले ग्लोबल क्लिपबोर्ड पर जाएं. ClipData.Item ऑब्जेक्ट की जांच करके देखें कि उसमें Intent है या नहीं. इसके बाद, इंटेंट को अपने स्टोरेज में कॉपी करने के लिए, getIntent() को कॉल करें. यहां दिए गए स्निपेट में इसे दिखाया गया है:

// Gets a handle to the Clipboard Manager.
val clipboard = getSystemService(Context.CLIPBOARD_SERVICE) as ClipboardManager

// Checks whether the clip item contains an Intent by testing whether
// getIntent() returns null.
val pasteIntent: Intent? = clipboard.primaryClip?.getItemAt(0)?.intent

if (pasteIntent != null) {

    // Handle the Intent.

} else {

    // Ignore the clipboard, or issue an error if
    // you expect an Intent to be on the clipboard.
}

// Gets a handle to the Clipboard Manager.
ClipboardManager clipboard = (ClipboardManager) getSystemService(Context.CLIPBOARD_SERVICE);

// Checks whether the clip item contains an Intent, by testing whether
// getIntent() returns null.
Intent pasteIntent = clipboard.getPrimaryClip().getItemAt(0).getIntent();

if (pasteIntent != null) {

    // Handle the Intent.

} else {

    // Ignore the clipboard, or issue an error if
    // you expect an Intent to be on the clipboard.
}

जब आपका ऐप्लिकेशन क्लिपबोर्ड का डेटा ऐक्सेस करता है, तो सिस्टम की सूचना दिखती है

Android 12 (एपीआई लेवल 31) और इसके बाद के वर्शन पर, जब आपका ऐप्लिकेशन getPrimaryClip() को कॉल करता है, तो सिस्टम आम तौर पर एक टोस्ट मैसेज दिखाता है. मैसेज में मौजूद टेक्स्ट का फ़ॉर्मैट इस तरह का होता है:

APP pasted from your clipboard

जब आपका ऐप्लिकेशन इनमें से कोई एक काम करता है, तो सिस्टम टोस्ट मैसेज नहीं दिखाता:

• अपने ऐप्लिकेशन से ClipData को ऐक्सेस करना.
• किसी ऐप्लिकेशन से ClipData को बार-बार ऐक्सेस किया जाता है. टोस्ट सिर्फ़ तब दिखता है, जब आपका ऐप्लिकेशन पहली बार उस ऐप्लिकेशन से डेटा ऐक्सेस करता है.
• क्लिप ऑब्जेक्ट के लिए मेटाडेटा को वापस लाता है. जैसे, getPrimaryClip() के बजाय getPrimaryClipDescription() को कॉल करके.

जटिल डेटा को कॉपी करने के लिए, कॉन्टेंट देने वाले का इस्तेमाल करना

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

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

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

यूआरआई पर किसी आइडेंटिफ़ायर को कोड में बदलना

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

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

"content://com.example.contacts"

अगर आपको इस यूआरआई में कोई नाम एन्कोड करना है, तो यहां दिए गए कोड स्निपेट का इस्तेमाल करें:

val uriString = "content://com.example.contacts/Smith"

// uriString now contains content://com.example.contacts/Smith.

// Generates a uri object from the string representation.
val copyUri = Uri.parse(uriString)

String uriString = "content://com.example.contacts" + "/" + "Smith";

// uriString now contains content://com.example.contacts/Smith.

// Generates a uri object from the string representation.
Uri copyUri = Uri.parse(uriString);

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

"content://com.example.contacts/people"
"content://com.example.contacts/people/detail"
"content://com.example.contacts/people/images"

यूआरआई कॉपी करने के लिए, कोई दूसरा पाथ जोड़ा जा सकता है:

"content://com.example.contacts/copying"

इसके बाद, पैटर्न-मैचिंग की मदद से "कॉपी" यूआरआई का पता लगाया जा सकता है. साथ ही, कॉपी और पेस्ट करने के लिए खास तौर पर बनाए गए कोड की मदद से, इसे मैनेज किया जा सकता है.

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

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

डेटा स्ट्रक्चर कॉपी करना

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

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

कॉन्टेंट देने वाले में, कम से कम इन तरीकों को बदलें:

query()

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

getType()

इस तरीके से, आपको उस डेटा के लिए एमआईएमई टाइप मिलने चाहिए जिसे आपको कॉपी करना है. newUri() तरीका, getType() को कॉल करता है, ताकि एमआईएमई टाइप को नए ClipData ऑब्जेक्ट में डाला जा सके.

जटिल डेटा के लिए एमआईएमई टाइप के बारे में, कॉन्टेंट देने वाले में बताया गया है.

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

यहां दिए गए स्निपेट में, जटिल डेटा को कॉपी करने के लिए ऐप्लिकेशन को सेट अप करने का तरीका बताया गया है:

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

   Kotlin

   // Declares the base URI string.
   private const val CONTACTS = "content://com.example.contacts"
   
   // Declares a path string for URIs that you use to copy data.
   private const val COPY_PATH = "/copy"
   
   // Declares a MIME type for the copied data.
   const val MIME_TYPE_CONTACT = "vnd.android.cursor.item/vnd.example.contact"

   Java

   // Declares the base URI string.
   private static final String CONTACTS = "content://com.example.contacts";
   
   // Declares a path string for URIs that you use to copy data.
   private static final String COPY_PATH = "/copy";
   
   // Declares a MIME type for the copied data.
   public static final String MIME_TYPE_CONTACT = "vnd.android.cursor.item/vnd.example.contact";

2. उस गतिविधि में क्लिपबोर्ड पर डेटा कॉपी करने के लिए कोड सेट अप करें जिससे उपयोगकर्ता डेटा कॉपी करते हैं. कॉपी करने के अनुरोध के जवाब में, यूआरआई को क्लिपबोर्ड पर डालें.

   Kotlin

   class MyCopyActivity : Activity() {
       ...
   when(item.itemId) {
       R.id.menu_copy -> { // The user has selected a name and is requesting a copy.
           // Appends the last name to the base URI.
           // The name is stored in "lastName".
           uriString = "$CONTACTS$COPY_PATH/$lastName"
   
           // Parses the string into a URI.
           val copyUri: Uri? = Uri.parse(uriString)
   
           // Gets a handle to the clipboard service.
           val clipboard = getSystemService(Context.CLIPBOARD_SERVICE) as ClipboardManager
   
           val clip: ClipData = ClipData.newUri(contentResolver, "URI", copyUri)
   
           // Sets the clipboard's primary clip.
           clipboard.setPrimaryClip(clip)
       }
   }

   Java

   public class MyCopyActivity extends Activity {
       ...
   // The user has selected a name and is requesting a copy.
   case R.id.menu_copy:
   
       // Appends the last name to the base URI.
       // The name is stored in "lastName".
       uriString = CONTACTS + COPY_PATH + "/" + lastName;
   
       // Parses the string into a URI.
       Uri copyUri = Uri.parse(uriString);
   
       // Gets a handle to the clipboard service.
       ClipboardManager clipboard = (ClipboardManager)
           getSystemService(Context.CLIPBOARD_SERVICE);
   
       ClipData clip = ClipData.newUri(getContentResolver(), "URI", copyUri);
   
       // Sets the clipboard's primary clip.
       clipboard.setPrimaryClip(clip);

3. कॉन्टेंट देने वाले के ग्लोबल स्कोप में, यूआरआई मैचर बनाएं और यूआरआई पैटर्न जोड़ें. यह पैटर्न, क्लिपबोर्ड पर मौजूद यूआरआई से मैच होना चाहिए.

   Kotlin

   // A Uri Match object that simplifies matching content URIs to patterns.
   private val sUriMatcher = UriMatcher(UriMatcher.NO_MATCH).apply {
   
       // Adds a matcher for the content URI. It matches.
       // "content://com.example.contacts/copy/*"
       addURI(CONTACTS, "names/*", GET_SINGLE_CONTACT)
   }
   
   // An integer to use in switching based on the incoming URI pattern.
   private const val GET_SINGLE_CONTACT = 0
   ...
   class MyCopyProvider : ContentProvider() {
       ...
   }

   Java

   public class MyCopyProvider extends ContentProvider {
       ...
   // A Uri Match object that simplifies matching content URIs to patterns.
   private static final UriMatcher sURIMatcher = new UriMatcher(UriMatcher.NO_MATCH);
   
   // An integer to use in switching based on the incoming URI pattern.
   private static final int GET_SINGLE_CONTACT = 0;
   ...
   // Adds a matcher for the content URI. It matches
   // "content://com.example.contacts/copy/*"
   sUriMatcher.addURI(CONTACTS, "names/*", GET_SINGLE_CONTACT);

4. query() तरीका सेट अप करें. यह तरीका, अलग-अलग यूआरआई पैटर्न को हैंडल कर सकता है. यह इस बात पर निर्भर करता है कि आपने इसे कैसे कोड किया है. हालांकि, इसमें सिर्फ़ क्लिपबोर्ड पर कॉपी करने की कार्रवाई का पैटर्न दिखता है.

   Kotlin

   // Sets up your provider's query() method.
   override fun query(
           uri: Uri,
           projection: Array<out String>?,
           selection: String?,
           selectionArgs: Array<out String>?,
           sortOrder: String?
   ): Cursor? {
       ...
       // When based on the incoming content URI:
       when(sUriMatcher.match(uri)) {
   
           GET_SINGLE_CONTACT -> {
   
               // Queries and returns the contact for the requested name. Decodes
               // the incoming URI, queries the data model based on the last name,
               // and returns the result as a Cursor.
           }
       }
       ...
   }

   Java

   // Sets up your provider's query() method.
   public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs,
       String sortOrder) {
       ...
       // Switch based on the incoming content URI.
       switch (sUriMatcher.match(uri)) {
   
       case GET_SINGLE_CONTACT:
   
           // Queries and returns the contact for the requested name. Decodes the
           // incoming URI, queries the data model based on the last name, and
           // returns the result as a Cursor.
       ...
   }

5. कॉपी किए गए डेटा के लिए सही एमआईएमई टाइप दिखाने के लिए, getType() तरीका सेट अप करें:

   Kotlin

   // Sets up your provider's getType() method.
   override fun getType(uri: Uri): String? {
       ...
       return when(sUriMatcher.match(uri)) {
           GET_SINGLE_CONTACT -> MIME_TYPE_CONTACT
           ...
       }
   }

   Java

   // Sets up your provider's getType() method.
   public String getType(Uri uri) {
       ...
       switch (sUriMatcher.match(uri)) {
       case GET_SINGLE_CONTACT:
           return (MIME_TYPE_CONTACT);
       ...
       }
   }

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

डेटा स्ट्रीम कॉपी करना

स्ट्रीम के तौर पर, टेक्स्ट और बाइनरी डेटा को कॉपी करके चिपकाया जा सकता है. डेटा इस तरह का हो सकता है:

• डिवाइस में सेव की गई फ़ाइलें
• सॉकेट से स्ट्रीम
• सेवा देने वाली कंपनी के मौजूदा डेटाबेस सिस्टम में सेव किया गया बड़ी मात्रा में डेटा

डेटा स्ट्रीम के लिए कॉन्टेंट देने वाला, Cursor ऑब्जेक्ट के बजाय AssetFileDescriptor जैसे फ़ाइल डिस्क्रिप्टर ऑब्जेक्ट की मदद से अपने डेटा का ऐक्सेस देता है. पेस्ट करने वाला ऐप्लिकेशन, फ़ाइल की जानकारी देने वाले इस डेटा का इस्तेमाल करके, डेटा स्ट्रीम को पढ़ता है.

किसी प्रोवाइडर के साथ डेटा स्ट्रीम को कॉपी करने के लिए, अपने ऐप्लिकेशन को सेट अप करने के लिए यह तरीका अपनाएं:

1. क्लिपबोर्ड पर सेव की जा रही डेटा स्ट्रीम के लिए, कॉन्टेंट यूआरआई सेट अप करें. ऐसा करने के लिए, ये विकल्प उपलब्ध हैं:
   • डेटा स्ट्रीम के लिए, यूआरआई पर एक आइडेंटिफ़ायर को एन्कोड करें. इसके बारे में यूआरआई पर आइडेंटिफ़ायर को एन्कोड करना सेक्शन में बताया गया है. इसके बाद, सेवा देने वाली कंपनी के डेटा में एक टेबल बनाएं. इसमें आइडेंटिफ़ायर और उससे जुड़ी स्ट्रीम का नाम शामिल होना चाहिए.
   • यूआरआई पर सीधे स्ट्रीम का नाम एन्कोड करें.
   • ऐसे यूनीक यूआरआई का इस्तेमाल करें जो सेवा देने वाली कंपनी से मौजूदा स्ट्रीम को हमेशा दिखाता हो. इस विकल्प का इस्तेमाल करने पर, जब भी यूआरआई का इस्तेमाल करके स्ट्रीम को क्लिपबोर्ड पर कॉपी किया जाए, तब अपने प्रोवाइडर को अपडेट करना न भूलें, ताकि वह किसी दूसरी स्ट्रीम पर ले जाए.
2. आपको जिस तरह की डेटा स्ट्रीम उपलब्ध करानी है उसके लिए एमआईएमई टाइप दें. पेस्ट करने वाले ऐप्लिकेशन को इस जानकारी की ज़रूरत होती है, ताकि यह तय किया जा सके कि वे क्लिपबोर्ड पर मौजूद डेटा को पेस्ट कर सकते हैं या नहीं.
3. ContentProvider के उन तरीकों में से किसी एक को लागू करें जो स्ट्रीम के लिए, फ़ाइल की जानकारी देने वाला दिखाता है. अगर कॉन्टेंट यूआरआई पर आइडेंटिफ़ायर को एन्कोड किया जाता है, तो इस तरीके का इस्तेमाल करके तय करें कि कौनसी स्ट्रीम खोलनी है.
4. डेटा स्ट्रीम को क्लिपबोर्ड पर कॉपी करने के लिए, कॉन्टेंट यूआरआई बनाएं और उसे क्लिपबोर्ड पर रखें.

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

यहां दी गई सूची में, कॉन्टेंट देने वाले के लिए फ़ाइल की जानकारी देने वाले सबसे ज़रूरी तरीके दिखाए गए हैं. इनमें से हर एक के लिए, एक ContentResolver तरीका होता है. इसमें तरीके के नाम के साथ "Descriptor" स्ट्रिंग जुड़ी होती है. उदाहरण के लिए, openAssetFile() का ContentResolver एनालॉग, openAssetFileDescriptor() है.

openTypedAssetFile()

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

यह तरीका, फ़ाइलों के सब-सेक्शन को मैनेज करता है. इसका इस्तेमाल, कॉन्टेंट देने वाले की ओर से क्लिपबोर्ड पर कॉपी की गई ऐसेट को पढ़ने के लिए किया जा सकता है.

openAssetFile()

यह तरीका, openTypedAssetFile() का ज़्यादा सामान्य रूप है. यह अनुमति वाले एमआईएमई टाइप के लिए फ़िल्टर नहीं करता है. हालांकि, यह फ़ाइलों के सब-सेक्शन पढ़ सकता है.

openFile()

यह openAssetFile() का ज़्यादा सामान्य फ़ॉर्म है. यह फ़ाइलों के सब-सेक्शन नहीं पढ़ सकता.

आपके पास फ़ाइल डिस्क्रिप्टर के साथ, openPipeHelper() का इस्तेमाल करने का विकल्प होता है. इससे, कॉन्टेंट को पेस्ट करने वाला ऐप्लिकेशन, पाइप का इस्तेमाल करके बैकग्राउंड थ्रेड में स्ट्रीम डेटा को पढ़ सकता है. इस तरीके का इस्तेमाल करने के लिए, ContentProvider.PipeDataWriter इंटरफ़ेस लागू करें.

कॉपी और पेस्ट करने की सुविधा को असरदार तरीके से डिज़ाइन करना

अपने ऐप्लिकेशन के लिए, कॉपी और पेस्ट करने की सुविधा को असरदार तरीके से डिज़ाइन करने के लिए, इन बातों का ध्यान रखें:

• क्लिपबोर्ड पर एक बार में सिर्फ़ एक क्लिप होती है. सिस्टम में मौजूद किसी भी ऐप्लिकेशन से कॉपी करने की नई कार्रवाई, पिछली क्लिप को ओवरराइट कर देती है. ऐसा हो सकता है कि उपयोगकर्ता आपके ऐप्लिकेशन से बाहर निकलकर, किसी दूसरे ऐप्लिकेशन से कॉन्टेंट कॉपी करे और फिर आपके ऐप्लिकेशन पर वापस आए. इसलिए, यह नहीं माना जा सकता कि क्लिपबोर्ड में वही कॉन्टेंट मौजूद है जिसे उपयोगकर्ता ने पहले आपके ऐप्लिकेशन में कॉपी किया था.
• हर क्लिप के लिए कई ClipData.Item ऑब्जेक्ट का मकसद, एक से ज़्यादा चुने गए ऑब्जेक्ट को कॉपी और पेस्ट करना है. इसका मकसद, चुने गए एक ऑब्जेक्ट के लिए अलग-अलग तरह के रेफ़रंस देना नहीं है. आम तौर पर, आपको किसी क्लिप में मौजूद सभी ClipData.Item ऑब्जेक्ट एक ही फ़ॉर्मैट में चाहिए होते हैं. इसका मतलब है कि वे सभी सामान्य टेक्स्ट, कॉन्टेंट यूआरआई या Intent होने चाहिए. इन्हें मिक्स नहीं किया जाना चाहिए.
• डेटा उपलब्ध कराते समय, अलग-अलग एमआईएमई रिप्रज़ेंटेशन ऑफ़र किए जा सकते हैं. ClipDescription में वे एमआईएमई टाइप जोड़ें जो आपके ऐप्लिकेशन के साथ काम करते हैं. इसके बाद, कॉन्टेंट देने वाले ऐप्लिकेशन में एमआईएमई टाइप लागू करें.
• क्लिपबोर्ड से डेटा लेते समय, आपके ऐप्लिकेशन की ज़िम्मेदारी होती है कि वह उपलब्ध एमआईएमई टाइप की जांच करे. इसके बाद, यह तय करे कि कौनसा एमआईएमई टाइप इस्तेमाल करना है. अगर क्लिपबोर्ड पर कोई क्लिप मौजूद है और उपयोगकर्ता उसे चिपकाने का अनुरोध करता है, तो आपके ऐप्लिकेशन को उसे चिपकाने की ज़रूरत नहीं है. अगर एमआईएमई टाइप काम करता है, तो कॉन्टेंट को चिपकाएं. coerceToText() का इस्तेमाल करके, क्लिपबोर्ड पर मौजूद डेटा को टेक्स्ट में बदला जा सकता है. अगर आपका ऐप्लिकेशन, उपलब्ध एमआईएमई टाइप में से एक से ज़्यादा टाइप के साथ काम करता है, तो उपयोगकर्ता को यह चुनने की सुविधा दी जा सकती है कि उसे कौनसा एमआईएमई टाइप इस्तेमाल करना है.