Ricevi contenuti avanzati

Gli utenti amano le immagini, i video e altri contenuti espressivi, ma l'inserimento e lo spostamento di questi contenuti nelle app non è sempre facile. Per semplificare la ricezione di contenuti avanzati da parte delle app, Android 12 (livello API 31) introduce un'API unificata che consente alla tua app di accettare contenuti da qualsiasi origine: appunti, tastiera o trascinamento.

Puoi collegare un'interfaccia, ad esempio OnReceiveContentListener, ai componenti della UI e ricevere un callback quando i contenuti vengono inseriti tramite qualsiasi meccanismo. Il callback diventa l'unico punto in cui il codice gestisce la ricezione di tutti i contenuti, dal testo normale e con stile al markup, alle immagini, ai video, ai file audio e altro ancora.

Per la compatibilità con le versioni precedenti di Android, questa API è disponibile anche in AndroidX, a partire da Core 1.7 e Appcompat 1.4, che ti consigliamo di utilizzare per l'implementazione di questa funzionalità.

Panoramica

Con altre API esistenti, ogni meccanismo dell'interfaccia utente, come il menu Tocca e tieni premuto o il trascinamento, ha la propria API corrispondente. Ciò significa che devi eseguire l'integrazione con ogni API separatamente, aggiungendo un codice simile per ogni meccanismo che inserisce contenuti:

L'API OnReceiveContentListener consolida questi diversi percorsi del codice creando un'unica API da implementare, in modo che tu possa concentrarti sulla logica specifica dell'app e lasciare che la piattaforma gestisca il resto:

Questo approccio significa anche che quando vengono aggiunti nuovi modi per inserire contenuti alla piattaforma, non è necessario apportare ulteriori modifiche al codice per abilitare il supporto nella tua app. Inoltre, se la tua app deve implementare la personalizzazione completa per un caso d'uso particolare, puoi comunque utilizzare le API esistenti, che continuano a funzionare allo stesso modo.

Implementazione

L'API è un'interfaccia listener con un singolo metodo, OnReceiveContentListener. Per supportare le versioni precedenti della piattaforma Android, ti consigliamo di utilizzare l'interfaccia OnReceiveContentListener corrispondente nella libreria AndroidX Core.

Per utilizzare l'API, implementa il listener specificando i tipi di contenuti che la tua app può gestire:

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

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

Dopo aver specificato tutti i tipi MIME dei contenuti supportati dalla tua app, implementa il resto del listener:

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

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

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

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

Se la tua app supporta già la condivisione con intent, puoi riutilizzare la logica specifica dell'app per la gestione degli URI dei contenuti. Restituisci i dati rimanenti per delegare la gestione di questi dati alla piattaforma.

Dopo aver implementato il listener, impostalo sugli elementi UI appropriati nella tua app:

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

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

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

Autorizzazioni URI

Le autorizzazioni in lettura vengono concesse e rilasciate automaticamente dalla piattaforma per tutti gli URI contenuto nel payload passato a OnReceiveContentListener.

In genere, l'app elabora gli URI dei contenuti in un servizio o un'attività. Per l'elaborazione a lunga esecuzione, utilizza WorkManager. Quando implementi questa funzionalità, estendi le autorizzazioni al servizio o all'attività di destinazione passando i contenuti utilizzando Intent.setClipData e impostando il flag FLAG_GRANT_READ_URI_PERMISSION.

In alternativa, puoi utilizzare un thread in background nel contesto corrente per elaborare i contenuti. In questo caso, devi mantenere un riferimento all'oggetto payload ricevuto dal listener per assicurarti che le autorizzazioni non vengano revocate prematuramente dalla piattaforma.

Elementi View personalizzati

Se la tua app utilizza una sottoclasse View personalizzata, assicurati che OnReceiveContentListener non venga ignorato.

Se la classe View esegue l'override del metodo onCreateInputConnection, utilizza l'API Jetpack InputConnectionCompat.createWrapper per configurare InputConnection.

Se la classe View esegue l'override del metodo onTextContextMenuItem, delega a super quando la voce di menu è R.id.paste o R.id.pasteAsPlainText.

Confronto con l'API Keyboard Image

Puoi considerare l'API OnReceiveContentListener come la versione successiva dell'API Keyboard Image esistente. Questa API unificata supporta la funzionalità dell'API Keyboard Image e alcune funzionalità aggiuntive. La compatibilità dei dispositivi e delle funzionalità varia a seconda che utilizzi la libreria Jetpack o le API native dell'SDK Android.