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

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

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

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

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

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

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

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

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

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

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

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

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

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

ClipboardManager

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

ClipData, ClipData.Item, और ClipDescription

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

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

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

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

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

ClipData के आसान तरीके

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

newPlainText(label, text)
ऐसा ClipData ऑब्जेक्ट दिखाता है जिसके एक ClipData.Item ऑब्जेक्ट में टेक्स्ट स्ट्रिंग होती है. ClipDescription ऑब्जेक्ट का लेबल, label पर सेट है. ClipDescription में एक MIME टाइप, MIMETYPE_TEXT_PLAIN है.

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

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

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

newIntent(label, intent)
एक ClipData ऑब्जेक्ट दिखाता है, जिसके एक ClipData.Item ऑब्जेक्ट में एक Intent होता है. ClipDescription ऑब्जेक्ट का लेबल, label पर सेट है. MIME टाइप को 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) से मिली है.

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

कॉपी और चिपकाने के फ़्रेमवर्क का ब्लॉक डायग्राम दिखाने वाली इमेज
दूसरी इमेज. Android क्लिपबोर्ड फ़्रेमवर्क.

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

डेटा को क्लिपबोर्ड पर कॉपी करने के लिए, ग्लोबल 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 13 में क्लिपबोर्ड की सूचना दिखाने वाला ऐनिमेशन
तीसरी इमेज. Android 13 और इसके बाद के वर्शन में, कॉन्टेंट के क्लिपबोर्ड में जाने पर दिखने वाला यूज़र इंटरफ़ेस (यूआई).

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

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

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

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

इन-ऐप्लिकेशन कॉपी के बाद स्नैकबार पोस्ट करें.
चौथी इमेज. अगर Android 13 में, कॉपी की पुष्टि करने वाले स्नैकबार को दिखाया जाता है, तो उपयोगकर्ता को डुप्लीकेट मैसेज दिखते हैं.
इन-ऐप्लिकेशन कॉपी के बाद, टॉस्ट पोस्ट करें.
पांचवीं इमेज. अगर 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 ऑब्जेक्ट में कॉन्टेंट यूआरआई है और आपको लगता है कि आपके पास उसके किसी MIME टाइप को मैनेज करने की सुविधा है, तो ContentResolver बनाएं और डेटा को वापस पाने के लिए, कॉन्टेंट उपलब्ध कराने वाले सही तरीके को कॉल करें.

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

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

    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. जांचें कि कॉन्टेंट उपलब्ध कराने वाली कंपनी, MIME टाइप के ऐसे वर्शन का इस्तेमाल करती है जिसे ऐप्लिकेशन समझता हो. अगर ऐसा है, तो डेटा पाने के लिए 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() को कॉल करें. नीचे दिया गया स्निपेट इसे दिखाता है:

Kotlin

// 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.
}

Java

// 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"

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

Kotlin

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)

Java

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()
इस तरीके से, आपको उस डेटा के MIME टाइप दिखने चाहिए जिसे कॉपी करना है. newUri() वाला तरीका, getType() को कॉल करता है, ताकि नए ClipData ऑब्जेक्ट में MIME टाइप डाले जा सकें.

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

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

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

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

    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() तरीका सेट अप करें, ताकि कॉपी किए गए डेटा के लिए, सही MIME टाइप दिया जा सके:

    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. आपको जिस तरह की डेटा स्ट्रीम ऑफ़र करनी है उसके लिए MIME टाइप दें. चिपकाने वाले ऐप्लिकेशन को इस जानकारी की ज़रूरत होती है, ताकि वे यह तय कर सकें कि वे क्लिपबोर्ड पर डेटा चिपकाएं या नहीं.
  3. ContentProvider में से कोई एक ऐसा तरीका लागू करें जो किसी स्ट्रीम के लिए फ़ाइल डिस्क्रिप्टर दिखाता हो. अगर आपने कॉन्टेंट यूआरआई पर आइडेंटिफ़ायर कोड में बदला है, तो यह तय करने के लिए इस तरीके का इस्तेमाल करें कि कौनसी स्ट्रीम खोलनी है.
  4. डेटा स्ट्रीम को क्लिपबोर्ड पर कॉपी करने के लिए, कॉन्टेंट का यूआरआई बनाएं और उसे क्लिपबोर्ड पर रखें.

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

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

openTypedAssetFile()

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

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

openAssetFile()
यह तरीका, openTypedAssetFile() का ज़्यादा सामान्य रूप है. यह अनुमति वाले MIME टाइप के लिए फ़िल्टर नहीं करता, लेकिन फ़ाइलों के सबसे छोटे हिस्सों को पढ़ सकता है.
openFile()
यह openAssetFile() का सामान्य फ़ॉर्मैट है. यह फ़ाइलों के उप-विभागों को नहीं पढ़ सकता.

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

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

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

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