Spécifier des cibles de partage direct

Utilisez les cibles de partage direct pour permettre aux utilisateurs d'autres applications de partager plus facilement et plus rapidement des URL, des images ou d'autres types de données avec votre application. Le partage direct permet de présenter les contacts d'applications de messagerie et de réseaux sociaux directement sur Android Sharesheet, sans que les utilisateurs n'aient à sélectionner l'application, puis à rechercher le contact.

ShortcutManagerCompat est une API AndroidX qui fournit des raccourcis de partage. Elle est rétrocompatible avec l'API ChooserTargetService obsolète. Il s'agit du moyen privilégié pour publier à la fois les raccourcis de partage et ChooserTargets. Pour obtenir des instructions, consultez Utiliser AndroidX pour fournir à la fois des raccourcis de partage et des cibles d'options sur cette page.

Publier les cibles de partage direct

La ligne Partage direct Sharesheet n'affiche que les raccourcis dynamiques fournis par l'API de raccourcis de partage. Pour publier des cibles de partage direct, procédez comme suit :

1. Dans le fichier de ressources XML de votre application, déclarez les éléments share-target.

   <shortcuts xmlns:android="http://schemas.android.com/apk/res/android">
   <share-target android:targetClass="com.example.android.sharingshortcuts.SendMessageActivity">
       <data android:mimeType="text/plain" />
       <category android:name="com.example.android.sharingshortcuts.category.TEXT_SHARE_TARGET" />
   </share-target>
   </shortcuts>
   

2. Lorsque votre application s'initialise, utilisez setDynamicShortcuts pour classer les raccourcis dynamiques par importance.

   Un index faible indique une importance plus importante. Si vous créez une application de communication, il peut s'agir de conversations principales classées en fonction de leur récence à mesure qu'elles apparaissent dans votre application. Ne publiez pas de raccourcis obsolètes. Une conversation sans activité de l'utilisateur au cours des 30 derniers jours est considérée comme obsolète.

   Kotlin

   ShortcutManagerCompat.setDynamicShortcuts(myContext, listOf(shortcut1, shortcut2, ..))
   

   Java

   List<ShortcutInfoCompat> shortcuts = new ArrayList<>();
   shortcuts.add(shortcut1);
   shortcuts.add(shortcut2);
   ...
   ShortcutManagerCompat.setDynamicShortcuts(myContext, shortcuts);
   
   

3. Si vous développez une application de communication, signalez immédiatement l'utilisation des raccourcis via pushDynamicShortcut chaque fois que l'utilisateur reçoit ou envoie un message à un contact. Pour en savoir plus, consultez Signaler l'utilisation des raccourcis pour les applications de communication sur cette page. Par exemple, signalez l'utilisation des messages envoyés par l'utilisateur en spécifiant la fonctionnalité actions.intent.SEND_MESSAGE dans le raccourci via ShortcutInfoCompat.Builder#addCapabilityBinding.

   Kotlin

   val shortcutInfo = ShortcutInfoCompat.Builder(myContext, staticConversationIdentifier)
     ...
     .setShortLabel(firstName)
     .setLongLabel(fullName)
     .setCategories(matchedCategories)
     .setLongLived(true)
   .addCapabilityBinding("actions.intent.SEND_MESSAGE").build()
   ShortcutManagerCompat.pushDynamicShortcut(myContext, shortcutInfo)
   

   Java

   ShortcutInfoCompat shortcutInfo = new ShortcutInfoCompat.Builder(myContext, staticConversationIdentifier)
     ...
     .setShortLabel(firstName)
     .setLongLabel(fullName)
     .setCategories(matchedCategories)
     .setLongLived(true)
     .addCapabilityBinding("actions.intent.SEND_MESSAGE")
     .build();
   
   ShortcutManagerCompat.pushDynamicShortcut(myContext, shortcutInfo);
   

4. Si l'utilisateur supprime un contact, utilisez removeLongLivedShortcut. Il s'agit de la méthode privilégiée pour supprimer le raccourci, qu'il soit mis en cache par les services système ou non. L'extrait de code suivant montre comment procéder.

   Kotlin

   val deleteShortcutId = "..."
   ShortcutManagerCompat.removeLongLivedShortcuts(myContext, listOf(deleteShortcutId))
   

   Java

   String deleteShortcutId = "...";
   ShortcutManagerCompat.removeLongLivedShortcuts(
       myContext, Arrays.asList(deleteShortcutId));
   
   

Améliorer le classement de vos cibles de partage direct

Android Sharesheet indique un nombre fixe de cibles de partage direct. Ces suggestions sont triées par classement. Vous pouvez améliorer le classement de vos raccourcis en procédant comme suit:

• Assurez-vous que tous les shortcutIds sont uniques et ne sont jamais réutilisés pour différentes cibles.
• Assurez-vous que le raccourci a une longue durée de vie en appelant setLongLived(true).
• Pour les raccourcis liés aux conversations, signalez l'utilisation des raccourcis pour les messages sortants et entrants en republiant les raccourcis correspondants via ShortcutManagerCompat.pushDynamicShortcut. Pour en savoir plus, consultez Signaler l'utilisation des raccourcis pour les applications de communication sur cette page.
• Évitez de fournir des cibles de partage direct non pertinentes ou obsolètes (par exemple, les contacts auxquels l'utilisateur n'a pas envoyé de message au cours des 30 derniers jours).
• Pour les applications SMS, évitez de fournir des raccourcis pour des numéros courts ou des conversations identifiées comme potentiellement indésirables. Il est très peu probable que les utilisateurs partagent du contenu dans ces conversations.
• Appelez setCategories() pour associer le raccourci aux attributs mimeType appropriés. Par exemple, pour une application de SMS, si le contact n'est pas compatible avec les RCS ou MMS, vous n'associerez pas le raccourci correspondant aux types MIME non textuels tels que image/* et video/*.
• Pour une conversation donnée, une fois qu'un raccourci dynamique a été transmis et que l'utilisation est signalée, ne modifiez pas l'ID du raccourci. Cela garantit la conservation des données d'utilisation à des fins de classement.

Si l'utilisateur appuie sur une cible de partage direct, votre application doit le rediriger vers une interface utilisateur dans laquelle il peut effectuer une action directement sur le sujet de la cible. Ne présentez pas à l'utilisateur une UI de sélection d'application et ne le placez pas dans une UI sans rapport avec la cible sur laquelle l'utilisateur appuie. Par exemple, dans une application de chat, appuyer sur une cible de partage direct permet à l'utilisateur d'accéder à une conversation avec la personne qu'il a sélectionnée. Le clavier est visible et le message est prérempli avec les données partagées.

API Share Shortcuts

À partir d'Android 10 (niveau d'API 29), ShortcutInfo.Builder a ajouté des méthodes et des améliorations qui fournissent des informations supplémentaires sur la cible de partage:

setCategories()

À partir d'Android 10, les catégories sont également utilisées pour filtrer les raccourcis pouvant gérer des actions ou des intents de partage. Pour en savoir plus, consultez la section Déclarer une cible de partage. Ce champ est obligatoire pour les raccourcis destinés à être utilisés comme cibles de partage.

setLongLived()

Spécifie si un raccourci est valide ou non lorsqu'il a été annulé ou rendu invisible par l'application (en tant que raccourci dynamique ou épinglé). Si un raccourci a une longue durée de vie, il peut être mis en cache par divers services système, même si sa publication en tant que raccourci dynamique a été annulée.

Créer un raccourci de longue durée peut améliorer son classement. Pour en savoir plus, consultez la section Obtenir le meilleur classement.

setShortLabel(), setLongLabel()

Lorsque vous publiez un raccourci pour une personne individuelle, veuillez inclure son nom complet dans setLongLabel() et tout nom court, comme un pseudo ou un prénom, dans setShortLabel().

Consultez un exemple de publication de raccourcis de partage sur GitHub.

Fournir des images de raccourci

Pour créer un raccourci de partage, vous devez ajouter une image via setIcon().

Les raccourcis de partage peuvent apparaître sur différentes surfaces du système et être remodelés. En outre, certains appareils équipés d'Android 7, 8 ou 9 (niveaux d'API 25, 26, 27 et 28) peuvent afficher des icônes ne comprenant que des éléments bitmap sans arrière-plan, ce qui réduit considérablement le contraste. Pour vous assurer que votre raccourci s'affiche comme prévu, fournissez un bitmap adaptatif à l'aide de IconCompat.createWithAdaptiveBitmap().

Assurez-vous que les bitmaps adaptatifs respectent les consignes et les dimensions définies pour les icônes adaptatives. La méthode la plus courante consiste à mettre à l'échelle le bitmap carré prévu à 72 x 72 dp et à le centrer dans un canevas transparent de 108 x 108 dp. Si votre icône inclut des zones transparentes, vous devez inclure une couleur d'arrière-plan. Sinon, les régions transparentes apparaissent en noir.

Ne fournissez pas d'images masquées selon une forme spécifique. Par exemple, avant Android 10 (niveau d'API 29), il était courant de fournir des avatars utilisateur pour les ChooserTarget de partage direct, masqués dans un cercle. Android Sharesheet et d'autres surfaces système d'Android 10 permettent désormais de mettre en forme et de thème les images de raccourci. La méthode privilégiée pour fournir des raccourcis de partage, via ShortcutManagerCompat, permet de mettre automatiquement en forme les objets ChooserTarget de partage direct avec les cercles pour vous.

Déclarer une cible de partage

Les cibles de partage doivent être déclarées dans le fichier de ressources de l'application, comme les définitions de raccourcis statiques. Ajoutez des définitions de cibles de partage dans l'élément racine <shortcuts> du fichier de ressources, ainsi que d'autres définitions de raccourcis statiques. Chaque élément <share-targets> contient des informations sur le type de données partagées, les catégories correspondantes et la classe cible qui gérera l'intent de partage. Le code XML ressemble à ceci:

<shortcuts xmlns:android="http://schemas.android.com/apk/res/android">
  <share-target android:targetClass="com.example.android.sharingshortcuts.SendMessageActivity">
    <data android:mimeType="text/plain" />
    <category android:name="com.example.android.sharingshortcuts.category.TEXT_SHARE_TARGET" />
  </share-target>
</shortcuts>

L'élément de données d'une cible de partage est semblable à la spécification de données d'un filtre d'intent. Chaque cible de partage peut avoir plusieurs catégories, qui ne sont utilisées que pour faire correspondre les raccourcis publiés d'une application avec ses définitions de cibles de partage. Les catégories peuvent avoir n'importe quelle valeur arbitraire définie par l'application.

Si l'utilisateur sélectionne le raccourci de partage dans Android Sharesheet qui correspond à l'exemple de partage cible ci-dessus, l'application recevra l'intent de partage suivant:

Action: Intent.ACTION_SEND
ComponentName: {com.example.android.sharingshortcuts /
                com.example.android.sharingshortcuts.SendMessageActivity}
Data: Uri to the shared content
EXTRA_SHORTCUT_ID: <ID of the selected shortcut>

Si l'utilisateur ouvre la cible de partage à partir des raccourcis du lanceur d'applications, l'application obtient l'intent créé lors de l'ajout du raccourci de partage à ShortcutManagerCompat. Comme il s'agit d'un intent différent, Intent.EXTRA_SHORTCUT_ID ne sera pas disponible, et vous devrez transmettre l'ID manuellement si vous en avez besoin.

Signaler l'utilisation des raccourcis pour les applis de communication

Si vous développez une application de communication, vous pouvez améliorer votre classement dans Android Sharesheet en signalant l'utilisation des messages sortants et entrants. Pour ce faire, publiez à nouveau le raccourci de conversation qui représente le contact via ShortcutManagerCompat.pushDynamicShortcut.

L'utilisation des raccourcis et les liaisons de fonctionnalités sont rétrocompatibles avec Android 5.0 (API 21).

Signaler l'utilisation des raccourcis pour les messages sortants

La création de rapports sur l'utilisation des messages envoyés par l'utilisateur revient à cliquer sur le bouton "Envoyer" après avoir créé un message.

Pour déclencher des rapports d'utilisation, spécifiez des liaisons de fonctionnalités dans le raccourci via ShortcutInfoCompat.Builder#addCapabilityBinding avec la fonctionnalité actions.intent.SEND_MESSAGE.

val shortcutInfo = ShortcutInfoCompat.Builder(myContext, staticConversationIdentifier)
  ...
  .setShortLabel(firstName)
  .setLongLabel(fullName)
  .setCategories(matchedCategories)
  .setLongLived(true)
.addCapabilityBinding("actions.intent.SEND_MESSAGE").build()
ShortcutManagerCompat.pushDynamicShortcut(myContext, shortcutInfo)

ShortcutInfoCompat shortcutInfo = new ShortcutInfoCompat.Builder(myContext, staticConversationIdentifier)
  ...
  .setShortLabel(firstName)
  .setLongLabel(fullName)
  .setCategories(matchedCategories)
  .setLongLived(true)
  .addCapabilityBinding("actions.intent.SEND_MESSAGE")
  .build();

ShortcutManagerCompat.pushDynamicShortcut(myContext, shortcutInfo);

Si le message sortant est destiné à un chat de groupe, vous devez également ajouter la valeur du paramètre Audience, car le type recipient est associé à la capacité.

val shortcutInfo = ShortcutInfoCompat.Builder(myContext, staticConversationIdentifier)
  ...
  .setShortLabel(groupShortTitle)
  .setLongLabel(groupLongTitle)
  .setCategories(matchedCategories)
  .setLongLived(true)
  .addCapabilityBinding("actions.intent.SEND_MESSAGE", "message.recipient.@type", listOf("Audience")).build()

ShortcutManagerCompat.pushDynamicShortcut(myContext, shortcutInfo)

ShortcutInfoCompat shortcutInfo = new ShortcutInfoCompat.Builder(myContext, staticConversationIdentifier)
  ...
  .setShortLabel(groupShortTitle)
  .setLongLabel(groupLongTitle)
  .setCategories(matchedCategories)
  .setLongLived(true)
  .addCapabilityBinding("actions.intent.SEND_MESSAGE", "message.recipient.@type", Arrays.asList("Audience"))
  .build();

ShortcutManagerCompat.pushDynamicShortcut(myContext, shortcutInfo);

Signaler l'utilisation des raccourcis pour les messages entrants

Pour déclencher des rapports d'utilisation lorsque l'utilisateur reçoit un SMS, un message de chat, un e-mail ou des notifications, vous devez également spécifier des liaisons de fonctionnalités dans le raccourci via ShortcutInfoCompat.Builder#addCapabilityBinding avec la fonctionnalité actions.intent.RECEIVE_MESSAGE.

val shortcutInfo = ShortcutInfoCompat.Builder(myContext, staticConversationIdentifier)
  ...
  .setShortLabel(firstName)
  .setLongLabel(fullName)
  .setCategories(matchedCategories)
  .setLongLived(true)
  .addCapabilityBinding("actions.intent.RECEIVE_MESSAGE").build()

ShortcutManagerCompat.pushDynamicShortcut(myContext, shortcutInfo)

ShortcutInfoCompat shortcutInfo = new ShortcutInfoCompat.Builder(myContext, staticConversationIdentifier)
  ...
  .setShortLabel(firstName)
  .setLongLabel(fullName)
  .setCategories(matchedCategories)
  .setLongLived(true)
  .addCapabilityBinding("actions.intent.RECEIVE_MESSAGE")
  .build();

ShortcutManagerCompat.pushDynamicShortcut(myContext, shortcutInfo);

Si le message entrant provient d'un chat de groupe, vous devez également ajouter la valeur du paramètre Audience, car le type sender est associé à la capacité.

val shortcutInfo = ShortcutInfoCompat.Builder(myContext, staticConversationIdentifier)
  ...
  .setShortLabel(groupShortTitle)
  .setLongLabel(groupLongTitle)
  .setCategories(matchedCategories)
  .setLongLived(true)
  .addCapabilityBinding("actions.intent.RECEIVE_MESSAGE", "message.sender.@type", listOf("Audience")).build()

ShortcutManagerCompat.pushDynamicShortcut(myContext, shortcutInfo)

ShortcutInfoCompat shortcutInfo = new ShortcutInfoCompat.Builder(myContext, staticConversationIdentifier)
  ...
  .setShortLabel(groupShortTitle)
  .setLongLabel(groupLongTitle)
  .setCategories(matchedCategories)
  .setLongLived(true)
  .addCapabilityBinding("actions.intent.RECEIVE_MESSAGE", "message.sender.@type", Arrays.asList("Audience"))
  .build();

ShortcutManagerCompat.pushDynamicShortcut(myContext, shortcutInfo);

Utiliser AndroidX pour fournir à la fois des raccourcis de partage et ChooserTargets

Pour pouvoir utiliser la bibliothèque de compatibilité AndroidX, le fichier manifeste de l'application doit contenir le sélecteur de métadonnées et l'ensemble de filtres d'intent. Découvrez l'API Direct Share ChooserTargetService actuelle.

Ce service est déjà déclaré dans la bibliothèque de compatibilité. L'utilisateur n'a donc pas besoin de le déclarer dans le fichier manifeste de l'application. Toutefois, le lien entre l'activité de partage et le service doit être pris en compte en tant que fournisseur cible du sélecteur.

Dans l'exemple suivant, l'implémentation de ChooserTargetService est androidx.core.content.pm.ChooserTargetServiceCompat, qui est déjà défini dans AndroidX:

<activity
    android:name=".SendMessageActivity"
    android:label="@string/app_name"
    android:theme="@style/SharingShortcutsDialogTheme">
    <!-- This activity can respond to Intents of type SEND -->
    <intent-filter>
        <action android:name="android.intent.action.SEND" />
        <category android:name="android.intent.category.DEFAULT" />
        <data android:mimeType="text/plain" />
    </intent-filter>
    <!-- Only needed if you import the sharetarget AndroidX library that
         provides backwards compatibility with the old DirectShare API.
         The activity that receives the Sharing Shortcut intent needs to be
         taken into account with this chooser target provider. -->
    <meta-data
        android:name="android.service.chooser.chooser_target_service"
        android:value="androidx.sharetarget.ChooserTargetServiceCompat" />
</activity>

Questions fréquentes sur les raccourcis de partage

Comment sont stockées les données d'utilisation des raccourcis et quittent-elles l'appareil ?

Les raccourcis sont entièrement stockés sur l'appareil, dans le répertoire des données système d'une partition de disque chiffrée. Les informations contenues dans les raccourcis, telles que l'icône, l'intent, ainsi que les noms de personnes et de ressources, ne sont accessibles qu'aux services système et à l'application qui publie les raccourcis.

Quelle est l'histoire du partage direct ?

Nous avons lancé le Partage direct dans Android 6.0 (niveau d'API 23) pour permettre aux applications de fournir des objets ChooserTarget via un ChooserTargetService. Les résultats ont été récupérés de manière réactive à la demande, ce qui ralentissait le temps de chargement des cibles.

Dans Android 10 (niveau d'API 29), nous avons remplacé les API de partage direct ChooserTargetService par la nouvelle API Sharing Shortcuts. Au lieu de récupérer les résultats de manière réactive à la demande, l'API Share Shortcuts permet aux applications de publier à l'avance des cibles de partage direct. Cela a rapidement accéléré le processus de récupération des cibles de partage direct lors de la préparation de la ShareSheet. Le mécanisme de partage direct ChooserTargetService continuera de fonctionner, mais le système classe les cibles fournies de cette manière en dessous de toute cible utilisant l'API de raccourcis de partage.

Android 11 (niveau d'API 30) a abandonné le service ChooserTargetService. L'API de raccourcis de partage est le seul moyen de fournir des cibles de partage direct.

En quoi les raccourcis publiés pour les cibles de partage sont-ils différents des raccourcis du lanceur d'applications (l'utilisation habituelle des raccourcis lorsque l'utilisateur appuie de manière prolongée sur les icônes d'application dans le lanceur d'applications) ?

Tous les raccourcis publiés à des fins de "cible de partage" sont également un raccourci de lanceur d'applications et s'affichent dans le menu lorsque vous appuyez de manière prolongée sur l'icône de votre application. Le nombre maximal de raccourcis par activité s'applique également au nombre total de raccourcis qu'une application publie (cibles de partage et anciens raccourcis de lanceur).

Quelle est la consigne concernant le nombre de raccourcis de partage qu'un utilisateur doit publier ?

Le nombre de raccourcis de partage est limité à la même limite de raccourcis dynamiques disponibles via getMaxShortcutCountPerActivity(android.content.Context). Vous pouvez publier n'importe quel nombre jusqu'à cette limite, mais n'oubliez pas que les raccourcis de partage peuvent être visibles en appuyant de manière prolongée sur le lanceur d'applications et dans la feuille de partage. La plupart des lanceurs d'applications affichent un maximum de quatre ou cinq raccourcis en mode Portrait et huit en mode Paysage. Consultez ces questions fréquentes pour en savoir plus et obtenir des conseils sur le partage des raccourcis.