Recevoir du contenu enrichi

Les utilisateurs apprécient les images, les vidéos et les autres contenus expressifs, mais l'insertion et le déplacement de ces contenus dans les applications ne sont pas toujours faciles. Pour faciliter la réception de contenu enrichi par les applications, Android 12 (niveau d'API 31) introduit une API unifiée qui permet à votre application d'accepter du contenu provenant de n'importe quelle source : presse-papiers, clavier ou glisser-déposer.

Vous pouvez associer une interface, telle que OnReceiveContentListener, aux composants d'interface utilisateur et recevoir un rappel lorsque du contenu est inséré par n'importe quel mécanisme. Le rappel devient l'emplacement unique où votre code gère la réception de tous les contenus, du texte brut et stylisé au balisage, en passant par les images, les vidéos, les fichiers audio, etc.

Pour assurer la rétrocompatibilité avec les versions précédentes d'Android, cette API est également disponible dans AndroidX, à partir de Core 1.7 et Appcompat 1.4, que nous vous recommandons d'utiliser lors de l'implémentation de cette fonctionnalité.

Présentation

Avec les autres API existantes, chaque mécanisme d'interface utilisateur (comme le menu "Appuyer de manière prolongée" ou le glisser-déposer) possède sa propre API correspondante. Cela signifie que vous devez intégrer chaque API séparément, en ajoutant un code similaire pour chaque mécanisme qui insère du contenu :

L'API OnReceiveContentListener consolide ces différents chemins de code sous la forme d'une seule API à implémenter. Vous pouvez ainsi vous concentrer sur la logique propre à votre application et laisser la plate-forme gérer le reste :

Cette approche signifie également que lorsque de nouvelles façons d'insérer du contenu sont ajoutées à la plate-forme, vous n'avez pas besoin d'apporter de modifications supplémentaires au code pour en permettre la prise en charge dans votre application. Si votre application doit implémenter une personnalisation complète pour un cas d'utilisation particulier, vous pouvez toujours utiliser les API existantes, qui continuent de fonctionner de la même manière.

Implémentation

L'API est une interface d'écoute avec une seule méthode, OnReceiveContentListener. Pour assurer la compatibilité avec les anciennes versions de la plate-forme Android, nous vous recommandons d'utiliser l'interface OnReceiveContentListener correspondante dans la bibliothèque AndroidX Core.

Pour utiliser l'API, implémentez l'écouteur en spécifiant les types de contenu que votre application peut gérer :

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/*"};
     // ...
}

Après avoir spécifié tous les types MIME de contenu compatibles avec votre application, implémentez le reste de l'écouteur :

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

Si votre application est déjà compatible avec le partage via des intents, vous pouvez réutiliser votre logique spécifique à l'application pour gérer les URI de contenu. Renvoyez toutes les données restantes pour déléguer leur traitement à la plate-forme.

Après avoir implémenté l'écouteur, définissez-le sur les éléments d'interface utilisateur appropriés de votre application :

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

Autorisations d'URI

Les autorisations de lecture sont automatiquement accordées et libérées par la plate-forme pour tous les URI de contenu présents dans la charge utile transmise à OnReceiveContentListener.

Normalement, votre application traite les URI de contenu dans un service ou une activité. Pour les traitements de longue durée, utilisez WorkManager. Lorsque vous implémentez cette fonctionnalité, étendez les autorisations au service ou à l'activité cible en transmettant le contenu à l'aide de Intent.setClipData et en définissant l'indicateur FLAG_GRANT_READ_URI_PERMISSION.

Vous pouvez également utiliser un thread d'arrière-plan dans le contexte actuel pour traiter le contenu. Dans ce cas, vous devez conserver une référence à l'objet payload reçu par l'écouteur pour vous assurer que les autorisations ne sont pas révoquées prématurément par la plate-forme.

Vues personnalisées

Si votre application utilise une sous-classe View personnalisée, veillez à ce que OnReceiveContentListener ne soit pas contourné.

Si votre classe View remplace la méthode onCreateInputConnection, utilisez l'API Jetpack InputConnectionCompat.createWrapper pour configurer InputConnection.

Si votre classe View remplace la méthode onTextContextMenuItem, déléguez à la super-classe lorsque l'élément de menu est R.id.paste ou R.id.pasteAsPlainText.

Comparaison avec l'API d'image clavier

Vous pouvez considérer l'API OnReceiveContentListener comme la prochaine version de l'API d'image clavier existante. Cette API unifiée est compatible avec les fonctionnalités de l'API d'image clavier, ainsi qu'avec d'autres fonctionnalités. La compatibilité des appareils et des fonctionnalités varie selon que vous utilisez la bibliothèque Jetpack ou les API natives du SDK Android.