Copia e incolla

Prova Compose

Jetpack Compose è il toolkit per la UI consigliato per Android. Scopri come utilizzare il copia e incolla in Scrivi.

Copia e incolla →

Android offre un potente framework basato sugli appunti per copiare e incollare. Supporta tipi di dati semplici e complessi, tra cui stringhe di testo, strutture di dati complesse, dati di stream di testo e binari e asset delle applicazioni. I dati di testo semplici vengono archiviati direttamente negli appunti, mentre i dati complessi vengono archiviati come riferimento che l'applicazione di destinazione risolve con un provider di contenuti. La copia e l'incolla funzionano sia all'interno di un'applicazione sia tra applicazioni che implementano il framework.

Poiché parte del framework utilizza i provider di contenuti, questo documento presuppone una certa familiarità con l'API Android Content Provider, descritta in Provider di contenuti.

Gli utenti si aspettano un feedback quando copiano contenuti negli appunti, quindi, oltre al framework che supporta la funzione di copia e incolla, Android mostra un'interfaccia utente predefinita agli utenti quando copiano in Android 13 (livello API 33) e versioni successive. A causa di questa funzionalità, esiste il rischio di notifiche duplicate. Puoi scoprire di più su questo caso limite nella sezione Evita notifiche duplicate.

Fornisci manualmente un feedback agli utenti quando copiano in Android 12L (livello API 32) e versioni precedenti. Consulta i suggerimenti in questo documento.

Il framework degli appunti

Quando utilizzi il framework degli appunti, inserisci i dati in un oggetto clip, quindi inserisci l'oggetto clip negli appunti a livello di sistema. L'oggetto clip può assumere una delle tre forme seguenti:

Testo

Una stringa di testo. Inserisci la stringa direttamente nell'oggetto clip, che poi inserisci negli appunti. Per incollare la stringa, recupera l'oggetto clip dagli appunti e copia la stringa nello spazio di archiviazione dell'applicazione.

URI

Un oggetto Uri che rappresenta qualsiasi forma di URI. Questa opzione è destinata principalmente alla copia di dati complessi da un provider di contenuti. Per copiare i dati, inserisci un oggetto Uri in un oggetto clip e inserisci l'oggetto clip negli appunti. Per incollare i dati, recupera l'oggetto clip, recupera l'oggetto Uri, risolvilo in un'origine dati, ad esempio un provider di contenuti, e copia i dati dall'origine nello spazio di archiviazione dell'applicazione.

Intent

Un Intent. In questo modo è possibile copiare le scorciatoie delle applicazioni. Per copiare i dati, crea un Intent, inseriscilo in un oggetto clip e inserisci l'oggetto clip negli appunti. Per incollare i dati, recupera l'oggetto clip e poi copia l'oggetto Intent nell'area di memoria dell'applicazione.

Gli appunti contengono un solo oggetto clip alla volta. Quando un'applicazione inserisce un oggetto clip negli appunti, l'oggetto clip precedente scompare.

Se vuoi consentire agli utenti di incollare dati nella tua applicazione, non devi gestire tutti i tipi di dati. Puoi esaminare i dati negli appunti prima di dare agli utenti la possibilità di incollarli. Oltre ad avere un determinato formato di dati, l'oggetto clip contiene anche metadati che indicano i tipi MIME disponibili. Questi metadati ti aiutano a decidere se la tua applicazione può fare qualcosa di utile con i dati degli appunti. Ad esempio, se hai un'applicazione che gestisce principalmente il testo, potresti voler ignorare gli oggetti clip che contengono un URI o un intent.

Potresti anche voler consentire agli utenti di incollare il testo indipendentemente dalla forma dei dati negli appunti. Per farlo, forza i dati degli appunti in una rappresentazione di testo e poi incolla questo testo. Questo è descritto nella sezione Forza gli appunti in testo.

Classi degli appunti

Questa sezione descrive le classi utilizzate dal framework degli appunti.

ClipboardManager

Gli appunti di sistema di Android sono rappresentati dalla classe globale ClipboardManager. Non creare un'istanza di questa classe direttamente. Invece, ottieni un riferimento richiamando getSystemService(CLIPBOARD_SERVICE).

ClipData, ClipData.Item e ClipDescription

Per aggiungere dati agli appunti, crea un oggetto ClipData che contenga una descrizione dei dati e i dati stessi. Gli appunti contengono un ClipData alla volta. Un ClipData contiene un oggetto ClipDescription e uno o più oggetti ClipData.Item.

Un oggetto ClipDescription contiene i metadati del clip. In particolare, contiene un array di tipi MIME disponibili per i dati del clip. Inoltre, su Android 12 (livello API 31) e versioni successive, i metadati includono informazioni sulla presenza di testo stilizzato nell'oggetto e sul tipo di testo nell'oggetto. Quando inserisci un clip negli appunti, queste informazioni sono disponibili per le applicazioni di incollaggio, che possono esaminare se possono gestire i dati del clip.

Un oggetto ClipData.Item contiene i dati di testo, URI o intent:

Testo

A CharSequence.

URI

A Uri. In genere contiene un URI del provider di contenuti, anche se è consentito qualsiasi URI. L'applicazione che fornisce i dati inserisce l'URI negli appunti. Le applicazioni che vogliono incollare i dati recuperano l'URI dagli appunti e lo utilizzano per accedere al provider di contenuti o a un'altra origine dati e recuperare i dati.

Intent

Un Intent. Questo tipo di dati ti consente di copiare una scorciatoia dell'applicazione negli appunti. Gli utenti possono quindi incollare la scorciatoia nelle loro applicazioni per utilizzarla in un secondo momento.

Puoi aggiungere più di un oggetto ClipData.Item a un clip. In questo modo, gli utenti possono copiare e incollare più selezioni come un unico clip. Ad esempio, se hai un widget elenco che consente all'utente di selezionare più elementi alla volta, puoi copiare tutti gli elementi negli appunti contemporaneamente. Per farlo, crea un ClipData.Item separato per ogni elemento dell'elenco, quindi aggiungi gli oggetti ClipData.Item all'oggetto ClipData.

Metodi di utilità ClipData

La classe ClipData fornisce metodi statici di convenienza per creare un oggetto ClipData con un singolo oggetto ClipData.Item e un oggetto ClipDescription semplice:

newPlainText(label, text)

Restituisce un oggetto ClipData il cui singolo oggetto ClipData.Item contiene una stringa di testo. L'etichetta dell'oggetto ClipDescription è impostata su label. Il singolo tipo MIME in ClipDescription è MIMETYPE_TEXT_PLAIN.

Utilizza newPlainText() per creare un clip da una stringa di testo.

newUri(resolver, label, URI)

Restituisce un oggetto ClipData il cui singolo oggetto ClipData.Item contiene un URI. L'etichetta dell'oggetto ClipDescription è impostata su label. Se l'URI è un URI contenuto, ovvero se Uri.getScheme() restituisce content:, il metodo utilizza l'oggetto ContentResolver fornito in resolver per recuperare i tipi MIME disponibili dal provider di contenuti. Poi li archivia in ClipDescription. Per un URI che non è un URI content:, il metodo imposta il tipo MIME su MIMETYPE_TEXT_URILIST.

Utilizza newUri() per creare un clip da un URI, in particolare un URI content:.

newIntent(label, intent)

Restituisce un oggetto ClipData il cui singolo oggetto ClipData.Item contiene un Intent. L'etichetta dell'oggetto ClipDescription è impostata su label. Il tipo MIME è impostato su MIMETYPE_TEXT_INTENT.

Utilizza newIntent() per creare un clip da un oggetto Intent.

Forza i dati degli appunti in testo

Anche se la tua applicazione gestisce solo testo, puoi copiare dati non testuali dagli appunti convertendoli con il metodo ClipData.Item.coerceToText().

Questo metodo converte i dati in ClipData.Item in testo e restituisce un CharSequence. Il valore restituito da ClipData.Item.coerceToText() si basa sulla forma dei dati in ClipData.Item:

Testo

Se ClipData.Item è un testo, ovvero se getText() non è null, coerceToText() restituisce il testo.

URI

Se ClipData.Item è un URI, ovvero se getUri() non è null, coerceToText() tenta di utilizzarlo come URI contenuto.

• Se l'URI è un URI contenuto e il provider può restituire uno stream di testo, coerceToText() restituisce uno stream di testo.
• Se l'URI è un URI contenuto, ma il provider non offre uno stream di testo, coerceToText() restituisce una rappresentazione dell'URI. La rappresentazione è la stessa restituita da Uri.toString().
• Se l'URI non è un URI contenuto, coerceToText() restituisce una rappresentazione dell'URI. La rappresentazione è la stessa restituita da Uri.toString().

Intent

Se ClipData.Item è un Intent, ovvero se getIntent() non è null, coerceToText() lo converte in un URI di intent e lo restituisce. La rappresentazione è la stessa restituita da Intent.toUri(URI_INTENT_SCHEME).

Il framework degli appunti è riassunto nella Figura 2. Per copiare i dati, un'applicazione inserisce un oggetto ClipData negli appunti globali ClipboardManager. ClipData contiene uno o più oggetti ClipData.Item e un oggetto ClipDescription. Per incollare i dati, un'applicazione recupera l'oggetto ClipData, recupera il tipo MIME dall'oggetto ClipDescription e recupera i dati dall'oggetto ClipData.Item o dal provider di contenuti a cui fa riferimento ClipData.Item.

Copia negli appunti

Per copiare i dati negli appunti, ottieni un handle per l'oggetto ClipboardManager globale, crea un oggetto ClipData e aggiungi un oggetto ClipDescription e uno o più oggetti ClipData.Item. Quindi, aggiungi l'oggetto ClipData completato all'oggetto ClipboardManager. Questo aspetto è descritto in dettaglio nella procedura seguente:

1. Se copi i dati utilizzando un URI contenuto, configura un provider di contenuti.
2. Recuperare gli appunti di sistema:

   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. Copia i dati in un nuovo oggetto ClipData:

   • Per il testo

     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!");

   • Per un URI

     Questo snippet crea un URI codificando un ID record nell'URI contenuto per il provider. Questa tecnica è descritta in modo più dettagliato nella sezione Codifica di un identificatore nell'URI.

     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);

   • Per un intent

     Questo snippet crea un Intent per un'applicazione e poi lo inserisce nell'oggetto clip:

     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. Inserisci il nuovo oggetto clip negli appunti:

   Kotlin

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

   Java

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

Fornire un feedback durante la copia negli appunti

Gli utenti si aspettano un feedback visivo quando un'app copia i contenuti negli appunti. Questa operazione viene eseguita automaticamente per gli utenti di Android 13 e versioni successive, ma deve essere implementata manualmente nelle versioni precedenti.

A partire da Android 13, il sistema visualizza una conferma visiva standard quando i contenuti vengono aggiunti agli appunti. La nuova conferma esegue le seguenti operazioni:

• Conferma che i contenuti sono stati copiati correttamente.
• Fornisce un'anteprima dei contenuti copiati.

In Android 12L (livello API 32) e versioni precedenti, gli utenti potrebbero non essere sicuri di aver copiato correttamente i contenuti o di cosa hanno copiato. Questa funzionalità standardizza le varie notifiche mostrate dalle app dopo la copia e offre agli utenti un maggiore controllo sugli appunti.

Evita le notifiche duplicate

In Android 12L (livello API 32) e versioni precedenti, ti consigliamo di avvisare gli utenti quando copiano correttamente fornendo un feedback visivo in-app, utilizzando un widget come Toast o Snackbar, dopo la copia.

Per evitare la visualizzazione di informazioni duplicate, ti consigliamo vivamente di rimuovere i toast o le snackbar mostrati dopo una copia in-app per Android 13 e versioni successive.

Ecco un esempio di come implementare questa funzionalità:

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()
}

Aggiungi contenuti sensibili agli appunti

Se la tua app consente agli utenti di copiare contenuti sensibili negli appunti, ad esempio password o dati della carta di credito, devi aggiungere un flag a ClipDescription in ClipData prima di chiamare ClipboardManager.setPrimaryClip(). L'aggiunta di questo flag impedisce la visualizzazione di contenuti sensibili nella conferma visiva dei contenuti copiati in Android 13 e versioni successive.

Per segnalare contenuti sensibili, aggiungi un extra booleano a ClipDescription. Tutte le app devono farlo, indipendentemente dal livello API target.

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

Incolla dagli appunti

Come descritto in precedenza, incolla i dati dagli appunti recuperando l'oggetto appunti globale, recuperando l'oggetto clip, esaminando i relativi dati e, se possibile, copiando i dati dall'oggetto clip nel tuo spazio di archiviazione. Questa sezione spiega in dettaglio come incollare i tre tipi di dati degli appunti.

Incolla testo normale

Per incollare testo normale, recupera gli appunti globali e verifica che possano restituire testo normale. Quindi, recupera l'oggetto clip e copia il testo nel tuo spazio di archiviazione utilizzando getText(), come descritto nella procedura seguente:

1. Recupera l'oggetto ClipboardManager globale utilizzando getSystemService(CLIPBOARD_SERVICE). Inoltre, dichiara una variabile globale per contenere il testo incollato:

   Kotlin

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

   Java

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

2. Determina se devi attivare o disattivare l'opzione "Incolla" nell'attività corrente. Verifica che gli appunti contengano un clip e che tu possa gestire il tipo di dati rappresentato dal clip:

   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. Copia i dati dagli appunti. Questo punto del codice è raggiungibile solo se la voce di menu "Incolla" è attiva, quindi puoi presumere che gli appunti contengano testo normale. Non sai ancora se contiene una stringa di testo o un URI che rimanda a un testo normale. Il seguente snippet di codice verifica questo aspetto, ma mostra solo il codice per la gestione del testo normale:

   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;
       }
   }

Incolla i dati da un URI contenuto

Se l'oggetto ClipData.Item contiene un URI contenuto e stabilisci di poter gestire uno dei suoi tipi MIME, crea un ContentResolver e chiama il metodo del provider di contenuti appropriato per recuperare i dati.

La seguente procedura descrive come ottenere dati da un provider di contenuti in base a un URI contenuto negli appunti. Controlla se un tipo MIME che l'applicazione può utilizzare è disponibile presso il provider.

1. Dichiara una variabile globale per contenere il tipo 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. Ottieni gli appunti globali. Inoltre, ottieni un resolver di contenuti per poter accedere al provider di contenuti:

   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. Recupera il clip principale dagli appunti e ottieni i relativi contenuti come URI:

   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. Verifica se l'URI è un URI contenuto chiamando getType(Uri). Questo metodo restituisce null se Uri non rimanda a un provider di contenuti valido.

   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. Verifica se il provider di contenuti supporta un tipo MIME comprensibile per l'applicazione. In questo caso, chiama ContentResolver.query() per recuperare i dati. Il valore restituito è un 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();
                }
            }
        }
   }

Incolla un intent

Per incollare un intent, devi prima recuperare gli appunti globali. Esamina l'oggetto ClipData.Item per verificare se contiene un Intent. Quindi chiama getIntent() per copiare l'intent nel tuo spazio di archiviazione. Lo snippet seguente lo dimostra:

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

Notifica di sistema mostrata quando l'app accede ai dati degli appunti

Su Android 12 (livello API 31) e versioni successive, il sistema di solito mostra un messaggio toast quando l'app chiama getPrimaryClip(). Il testo all'interno del messaggio contiene il seguente formato:

APP pasted from your clipboard

Il sistema non mostra un messaggio toast quando l'app esegue una delle seguenti operazioni:

• Accede a ClipData dalla tua app.
• Accede ripetutamente a ClipData da un'app specifica. Il toast viene visualizzato solo quando la tua app accede ai dati di quell'app per la prima volta.
• Recupera i metadati per l'oggetto clip, ad esempio chiamando getPrimaryClipDescription() anziché getPrimaryClip().

Utilizza i provider di contenuti per copiare dati complessi

I provider di contenuti supportano la copia di dati complessi, come record di database o stream di file. Per copiare i dati, inserisci un URI contenuto negli appunti. Le applicazioni di destinazione recuperano questo URI dagli appunti e lo utilizzano per recuperare i dati del database o i descrittori del flusso di file.

Poiché l'applicazione di destinazione ha solo l'URI contenuto per i tuoi dati, deve sapere quale dato recuperare. Puoi fornire queste informazioni codificando un identificatore per i dati nell'URI stesso oppure puoi fornire un URI univoco che restituisca i dati che vuoi copiare. La tecnica da scegliere dipende dall'organizzazione dei dati.

Le sezioni seguenti descrivono come configurare gli URI, fornire dati complessi e fornire stream di file. Le descrizioni presuppongono che tu abbia familiarità con i principi generali della progettazione dei provider di contenuti.

Codifica un identificatore nell'URI

Una tecnica utile per copiare i dati negli appunti con un URI consiste nel codificare un identificatore per i dati nell'URI stesso. Il provider di contenuti può quindi ottenere l'identificatore dall'URI e utilizzarlo per recuperare i dati. L'applicazione che incolla non deve sapere che l'identificatore esiste. Deve solo recuperare il "riferimento", ovvero l'URI più l'identificatore, dagli appunti, fornirlo al provider di contenuti e recuperare i dati.

In genere, un identificatore viene codificato in un URI contenuto concatenandolo alla fine dell'URI. Ad esempio, supponiamo di definire l'URI del provider come la seguente stringa:

"content://com.example.contacts"

Se vuoi codificare un nome in questo URI, utilizza il seguente snippet di codice:

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);

Se utilizzi già un provider di contenuti, ti consigliamo di aggiungere un nuovo percorso URI che indichi che l'URI è destinato alla copia. Ad esempio, supponiamo che tu abbia già i seguenti percorsi URI:

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

Puoi aggiungere un altro percorso per copiare gli URI:

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

Puoi quindi rilevare un URI "copy" tramite la corrispondenza di pattern e gestirlo con un codice specifico per la copia e l'incolla.

In genere, la tecnica di codifica viene utilizzata se utilizzi già un provider di contenuti, un database interno o una tabella interna per organizzare i dati. In questi casi, hai più dati che vuoi copiare e presumibilmente un identificatore univoco per ciascuno. In risposta a una query dell'applicazione di incollamento, puoi cercare i dati in base al relativo identificatore e restituirli.

Se non hai più dati, probabilmente non è necessario codificare un identificatore. Puoi utilizzare un URI univoco per il tuo provider. In risposta a una query, il provider restituisce i dati che contiene attualmente.

Copia le strutture di dati

Configura un provider di contenuti per copiare e incollare dati complessi come sottoclasse del componente ContentProvider. Codifica l'URI che hai inserito negli appunti in modo che rimandi al record esatto che vuoi fornire. Inoltre, considera lo stato esistente della tua applicazione:

• Se hai già un provider di contenuti, puoi aggiungerne la funzionalità. Potresti dover modificare solo il metodo query() per gestire gli URI provenienti da applicazioni che vogliono incollare dati. Probabilmente vorrai modificare il metodo per gestire un pattern URI "copy".
• Se la tua applicazione gestisce un database interno, ti consigliamo di spostarlo in un provider di contenuti per facilitare la copia.
• Se non utilizzi un database, puoi implementare un semplice provider di contenuti il cui unico scopo è offrire dati alle applicazioni che incollano dagli appunti.

Nel provider di contenuti, esegui l'override di almeno i seguenti metodi:

query()

Le applicazioni di destinazione presuppongono di poter ottenere i tuoi dati utilizzando questo metodo con l'URI che hai inserito negli appunti. Per supportare la copia, fai in modo che questo metodo rilevi gli URI contenenti un percorso "copy" speciale. L'applicazione può quindi creare un URI di "copia" da inserire negli appunti, contenente il percorso di copia e un puntatore al record esatto che vuoi copiare.

getType()

Questo metodo deve restituire i tipi MIME per i dati che intendi copiare. Il metodo newUri() chiama getType() per inserire i tipi MIME nel nuovo oggetto ClipData.

I tipi MIME per i dati complessi sono descritti in Provider di contenuti.

Non è necessario disporre di altri metodi del provider di contenuti, come insert() o update(). Un'applicazione di destinazione deve solo recuperare i tipi MIME supportati e copiare i dati dal provider. Se hai già questi metodi, non interferiranno con le operazioni di copia.

I seguenti snippet mostrano come configurare l'applicazione per copiare dati complessi:

1. Nelle costanti globali della tua applicazione, dichiara una stringa URI di base e un percorso che identifica le stringhe URI che utilizzi per copiare i dati. Dichiara anche un tipo MIME per i dati copiati.

   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. Nell'attività da cui gli utenti copiano i dati, configura il codice per copiare i dati negli appunti. In risposta a una richiesta di copia, inserisci l'URI negli appunti.

   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. Nell'ambito globale del tuo provider di contenuti, crea un matcher URI e aggiungi un pattern URI che corrisponda agli URI che inserisci negli appunti.

   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. Configura il metodo query(). Questo metodo può gestire diversi pattern URI, a seconda di come lo codifichi, ma viene mostrato solo il pattern per l'operazione di copia negli appunti.

   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. Configura il metodo getType() in modo che restituisca un tipo MIME appropriato per i dati copiati:

   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);
       ...
       }
   }

La sezione Incolla i dati da un URI contenuto descrive come ottenere un URI contenuto dagli appunti e utilizzarlo per ottenere e incollare i dati.

Copia gli stream di dati

Puoi copiare e incollare grandi quantità di testo e dati binari come stream. I dati possono avere forme come le seguenti:

• File archiviati sul dispositivo effettivo
• Stream da socket
• Grandi quantità di dati archiviati nel sistema di database sottostante di un provider

Un provider di contenuti per gli stream di dati fornisce l'accesso ai propri dati con un oggetto descrittore del file, come AssetFileDescriptor, anziché un oggetto Cursor. L'applicazione di destinazione legge il flusso di dati utilizzando questo descrittore del file.

Per configurare l'applicazione in modo da copiare un flusso di dati con un provider, segui questi passaggi:

1. Configura un URI contenuto per lo stream di dati che stai inserendo negli appunti. Le opzioni per farlo includono:
   • Codifica un identificatore per lo stream di dati nell'URI, come descritto nella sezione Codifica un identificatore nell'URI, quindi mantieni una tabella nel provider contenente gli identificatori e il nome dello stream corrispondente.
   • Codifica il nome dello stream direttamente nell'URI.
   • Utilizza un URI univoco che restituisca sempre lo stream corrente dal provider. Se utilizzi questa opzione, ricordati di aggiornare il provider in modo che rimandi a uno stream diverso ogni volta che copi lo stream negli appunti utilizzando l'URI.
2. Fornisci un tipo MIME per ogni tipo di stream di dati che intendi offrire. Le applicazioni di destinazione hanno bisogno di queste informazioni per determinare se possono incollare i dati negli appunti.
3. Implementa uno dei metodi ContentProvider che restituisce un descrittore del file per uno stream. Se codifichi gli identificatori nell'URI contenuto, utilizza questo metodo per determinare quale stream aprire.
4. Per copiare lo stream di dati negli appunti, crea l'URI contenuto e inseriscilo negli appunti.

Per incollare un flusso di dati, un'applicazione recupera il clip dagli appunti, recupera l'URI e lo utilizza in una chiamata a un metodo del descrittore del file ContentResolver che apre lo stream. La chiamata al metodo ContentResolver chiama il metodo ContentProvider corrispondente, passandogli l'URI contenuto. Il provider restituisce il descrittore del file al metodo ContentResolver. L'applicazione di destinazione ha quindi la responsabilità di leggere i dati dallo stream.

L'elenco seguente mostra i metodi del descrittore del file più importanti per un provider di contenuti. Ognuno di questi ha un metodo ContentResolver corrispondente con la stringa "Descriptor" aggiunta al nome del metodo. Ad esempio, l'analogo ContentResolver di openAssetFile() è openAssetFileDescriptor().

openTypedAssetFile()

Questo metodo restituisce un descrittore del file dell'asset, ma solo se il tipo MIME fornito è supportato dal provider. Il chiamante, ovvero l'applicazione che esegue l'operazione di incolla, fornisce un pattern di tipo MIME. Il provider di contenuti dell'applicazione che copia un URI negli appunti restituisce un handle di file AssetFileDescriptor se può fornire quel tipo MIME e genera un'eccezione se non può.

Questo metodo gestisce le sottosezioni dei file. Puoi utilizzarlo per leggere gli asset che il provider di contenuti ha copiato negli appunti.

openAssetFile()

Questo metodo è una forma più generale di openTypedAssetFile(). Non filtra per tipi MIME consentiti, ma può leggere sottosezioni di file.

openFile()

Questa è una forma più generale di openAssetFile(). Non può leggere sottosezioni di file.

Facoltativamente, puoi utilizzare il metodo openPipeHelper() con il metodo del descrittore del file. In questo modo, l'applicazione di destinazione può leggere i dati dello stream in un thread in background utilizzando una pipe. Per utilizzare questo metodo, implementa l'interfaccia ContentProvider.PipeDataWriter.

Progetta una funzionalità di copia e incolla efficace

Per progettare una funzionalità di copia e incolla efficace per la tua applicazione, tieni presente questi punti:

• Negli appunti è presente un solo clip alla volta. Una nuova operazione di copia eseguita da qualsiasi applicazione nel sistema sovrascrive il clip precedente. Poiché l'utente potrebbe uscire dalla tua applicazione e copiare prima di tornare, non puoi presumere che gli appunti contengano il clip che l'utente ha copiato in precedenza nella tua applicazione.
• Lo scopo previsto di più oggetti ClipData.Item per clip è supportare la copia e l'incolla di più selezioni anziché diverse forme di riferimento a una singola selezione. In genere, tutti gli oggetti ClipData.Item di un clip devono avere la stessa forma. In altre parole, devono essere tutti testo semplice, URI contenuto o Intent e non misti.
• Quando fornisci i dati, puoi offrire diverse rappresentazioni MIME. Aggiungi i tipi MIME supportati a ClipDescription, quindi implementali nel tuo provider di contenuti.
• Quando recuperi i dati dagli appunti, la tua applicazione è responsabile del controllo dei tipi MIME disponibili e della decisione su quale utilizzare, se presente. Anche se negli appunti è presente un clip e l'utente richiede un'operazione di incolla, l'applicazione non è tenuta a eseguirla. Esegui l'incolla se il tipo MIME è compatibile. Puoi forzare i dati negli appunti in testo utilizzando coerceToText(). Se la tua applicazione supporta più di uno dei tipi MIME disponibili, puoi consentire all'utente di scegliere quale utilizzare.