Les utilisateurs adorent les images, les vidéos et les autres contenus expressifs, mais insérer et déplacer ce contenu dans les applications n'est pas toujours facile. Pour que les applications reçoivent plus facilement du contenu enrichi, 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 déplacement.
Vous pouvez associer une interface, telle que OnReceiveContentListener, à des composants d'interface utilisateur et recevoir un rappel lorsque du contenu est inséré via un mécanisme. Le rappel devient l'endroit unique où votre code gère la réception de tout le contenu, 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 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 (tel que le menu en appuyant de manière prolongée ou le déplacement) dispose 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 d'insertion de contenu:
L'API OnReceiveContentListener regroupe 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:
Cette approche signifie également que lorsque de nouvelles méthodes d'insertion de contenu sont ajoutées à la plate-forme, vous n'avez pas besoin d'apporter de modifications de code supplémentaires pour activer la prise en charge de 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 à 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 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:
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 est déjà compatible avec 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 afin de 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 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 les traitements de longue durée, utilisez WorkManager. Lorsque vous implémentez cette méthode, é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, assurez-vous 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 à "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 l'API d'image de clavier ainsi que certaines fonctionnalités supplémentaires. La compatibilité des appareils et des fonctionnalités varie selon que vous utilisez la bibliothèque Jetpack ou les API natives du SDK Android.
| Action ou fonctionnalité | Pris en charge par l'API d'image 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 appuyant de manière prolongée sur le menu | Non | Oui |
| Insérer par glisser-déposer | Non | Oui (niveau d'API 24 ou supérieur) |
| Action ou fonctionnalité | Pris en charge par l'API d'image 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 appuyant de manière prolongée sur le menu | Non | |
| Insérer par glisser-déposer | Non |