Recevoir du contenu enrichi

Figure 1 : L'API unifiée permet de gérer de manière centralisée le contenu entrant, quel que soit le mécanisme spécifique de l'interface utilisateur (par exemple, lorsque l'utilisateur effectue un collage depuis le menu "Appuyer de manière prolongée" ou "glisser-déposer").

Les utilisateurs adorent les images, les vidéos et d'autres contenus expressifs, mais il n'est pas toujours facile d'insérer et de déplacer ces contenus dans les applications. Pour permettre aux applications de recevoir du contenu enrichi plus facilement, 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'UI et recevoir un rappel lorsque du contenu est inséré par n'importe quel mécanisme. Le rappel devient l'endroit unique où votre code peut gérer la réception de tous les contenus, du texte brut et stylisé au balisage, aux images, aux vidéos, aux fichiers audio, etc.

Pour assurer la rétrocompatibilité avec les versions précédentes d'Android, cette API est également disponible sur 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 (par exemple, appuyer de manière prolongée sur le menu ou le faire glisser) possède sa propre API correspondante. Cela signifie que vous devez procéder à l'intégration avec chaque API séparément, en ajoutant un code similaire pour chaque mécanisme qui insère du contenu:

Image montrant les différentes actions et l'API relative à implémenter
Figure 2 : Auparavant, les applications implémentaient une API différente pour chaque mécanisme d'insertion de contenu d'interface utilisateur.

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

Image montrant l'API unifiée simplifiée
Figure 3 : L'API unifiée vous permet d'implémenter une seule API compatible avec tous les mécanismes d'interface utilisateur.

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 permettre la compatibilité avec votre application. De plus, 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'écouteur avec une seule méthode, OnReceiveContentListener. Pour prendre en charge les anciennes versions de la plate-forme Android, nous vous recommandons d'utiliser l'interface OnReceiveContentListener correspondante de la bibliothèque AndroidX Core.

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

Kotlin

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

Java

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:

Kotlin

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

Java

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

     @Override
     public ContentInfoCompat onReceiveContent(View view, ContentInfoCompat contentInfo) {
         Pair 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 prend déjà en charge le partage avec des intents, vous pouvez réutiliser la logique spécifique à votre application pour gérer les URI de contenu. Renvoyez toutes les données restantes pour déléguer le traitement de ces données à la plate-forme.

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

Kotlin

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

Java

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 accordées et libérées automatiquement par la plate-forme pour tous les URI de contenu dans la charge utile transmise à OnReceiveContentListener.

Normalement, votre application traite les URI de contenu dans un service ou une activité. Pour un traitement de longue durée, utilisez WorkManager. Lors de la mise en œuvre, étendez les autorisations au service ou à l'activité cible en transmettant le contenu à l'aide de Intent.setClipData et en définissant l'option 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 n'est 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 l'accès à la commande Super 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 que 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.

Tableau 1. Fonctionnalités et niveaux d'API compatibles avec Jetpack
Action ou fonctionnalité Compatible avec l'API d'image du clavier Compatible avec l'API unifiée
Insérer à partir du clavier Oui (niveau d'API 13 ou supérieur) Oui (niveau d'API 13 ou supérieur)
Insérer en utilisant la fonction Coller depuis le menu "Appuyer de manière prolongée" Non Oui
Insérer par glisser-déposer Non Oui (niveau d'API 24 ou supérieur)
Tableau 2. Fonctionnalités et niveaux d'API compatibles pour les API natives
Action ou fonctionnalité Compatible avec l'API d'image du clavier Compatible avec l'API unifiée
Insérer à partir du clavier Oui (niveau d'API 25 ou supérieur) Oui (Android 12 ou version ultérieure)
Insérer en utilisant la fonction Coller depuis le menu "Appuyer de manière prolongée" Non
Insérer par glisser-déposer Non