Cómo proporcionar objetivos de Direct Share

Usa los destinos de uso compartido directo para que los usuarios de otras apps compartan URLs, imágenes y otros tipos de datos con tu app de forma más fácil y rápida. Direct Share funciona presentando contactos de apps de mensajería y redes sociales directamente en la hoja compartida de Android, sin que los usuarios tengan que seleccionar la app y, luego, buscar el contacto.

ShortcutManagerCompat es una API de AndroidX que proporciona accesos directos de uso compartido y que es retrocompatible con la API de ChooserTargetService que dejó de estar disponible. Esta es la manera preferida de publicar accesos directos de uso compartido y ChooserTargets. Para obtener instrucciones, consulta Cómo usar AndroidX para proporcionar accesos directos de uso compartido y ChooserTargets en esta página.

Cómo publicar objetivos de Direct Share

La fila de Direct Share de la hoja compartida solo muestra los accesos directos dinámicos que proporciona la API de accesos directos de uso compartido. Completa los siguientes pasos para publicar objetivos de Compartir directamente.

1. En el archivo de recursos XML de tu app, declara elementos 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. Cuando se inicialice tu app, usa setDynamicShortcuts para ordenar los accesos directos dinámicos por importancia.

   Un índice más bajo indica más importancia. Si estás creando una app de comunicación, pueden ser conversaciones principales ordenadas por fecha de actualización, tal como aparecen en tu app. No publiques atajos inactivos; una conversación sin actividad del usuario en los últimos 30 días se considera inactiva.

   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 desarrollas una app de comunicación, informa el uso de los atajos a través de pushDynamicShortcut de inmediato cada vez que el usuario reciba o envíe un mensaje a un contacto. Consulta Cómo informar el uso de atajos para apps de comunicación en esta página para obtener más información. Por ejemplo, informa el uso de los mensajes que envía el usuario especificando vinculaciones de capacidades en el atajo a través de ShortcutInfoCompat.Builder#addCapabilityBinding con la capability actions.intent.SEND_MESSAGE.

   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 el usuario borra un contacto, usa removeLongLivedShortcut. Esta es la forma preferida de quitar el acceso directo, independientemente de si los servicios del sistema lo almacenan en caché. En el siguiente fragmento de código, se muestra un ejemplo de cómo hacerlo.

   Kotlin

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

   Java

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

Mejora las clasificaciones de tus objetivos de Direct Share

Android Sharesheet muestra una cantidad fija de objetivos de Direct Share. Estas sugerencias se ordenan según su clasificación. Puedes hacer lo siguiente para mejorar potencialmente la clasificación de tus accesos directos:

• Asegúrate de que todos los shortcutIds sean únicos y que nunca se reutilicen para diferentes objetivos.
• Asegúrate de que el acceso directo sea permanente. Para ello, llama a setLongLived(true).
• Para los accesos directos relacionados con la conversación, informa el uso de los accesos directos para los mensajes entrantes y salientes. Para ello, vuelve a publicar los accesos directos correspondientes a través de ShortcutManagerCompat.pushDynamicShortcut. Consulta Cómo informar el uso de atajos para apps de comunicación en esta página para obtener más detalles.
• Evita proporcionar objetivos de Compartir directamente irrelevantes o inactivos, por ejemplo, contactos a los que el usuario no les envió mensajes en los últimos 30 días.
• En el caso de las apps de SMS, evita proporcionar atajos para códigos cortos o conversaciones identificadas como posibles spam. Es muy poco probable que los usuarios compartan contenido en esas conversaciones.
• Llama a setCategories() para asociar el atajo con los atributos mimeType adecuados. Por ejemplo, en el caso de una app de SMS, si el contacto no está habilitado para RCS o MMS, no asociarías el atajo correspondiente con tipos MIME que no sean de texto, como image/* y video/*.
• Para una conversación determinada, una vez que se envíe un atajo dinámico y se informe el uso, no cambies el ID del atajo. Esto garantiza la retención de los datos de uso para la clasificación.

Si el usuario presiona cualquier objetivo de Direct Share, tu app debe llevarlo a una IU en la que pueda realizar una acción directamente en el asunto del objetivo. No le muestres al usuario una IU de desambiguación ni lo coloques en una IU que no esté relacionada con el objetivo presionado. Por ejemplo, en una app de mensajería, presionar un objetivo de Direct Share lleva al usuario a una vista de conversación con la persona seleccionada. El teclado es visible y el mensaje se autocompleta con los datos compartidos.

API de accesos directos de uso compartido

A partir de Android 10 (nivel de API 29), ShortcutInfo.Builder agregó métodos y mejoras que proporcionan información adicional sobre el objetivo de uso compartido:

setCategories()

A partir de Android 10, las categorías también se usan para filtrar los accesos directos que pueden administrar intents o acciones de uso compartido. Para obtener más información, consulta Cómo declarar un objetivo de uso compartido. Este campo es obligatorio para los accesos directos que se deben usar como objetivos de uso compartido.

setLongLived()

Especifica si un acceso directo es válido o no cuando la app anula su publicación o lo oculta (ya sea un acceso directo dinámico o fijo). Si un acceso directo es permanente, puede almacenarse en la caché de diversos servicios del sistema, incluso en el caso de que se anule su publicación como acceso directo dinámico.

Hacer que un acceso directo sea permanente puede mejorar su clasificación. Para obtener más información, consulta Cómo obtener la mejor clasificación.

setShortLabel(), setLongLabel()

Cuando publiques un acceso directo para una persona en particular, incluye su nombre completo en setLongLabel() y cualquier nombre corto, como un sobrenombre o un nombre de pila en setShortLabel().

Consulta un ejemplo de cómo publicar Accesos directos de uso compartido en GitHub.

Cómo proporcionar imágenes para accesos directos

Para crear un acceso directo de uso compartido, tendrás que agregar una imagen mediante setIcon().

Los accesos directos de uso compartido pueden aparecer en varias plataformas del sistema y se pueden modificar. Además, es posible que algunos dispositivos con versiones 7, 8 o 9 de Android (niveles de API 25, 26, 27 y 28) muestren íconos solo de mapa de bits sin fondo, lo que disminuye drásticamente el contraste. Para asegurarte de que tu acceso directo se vea como corresponde, proporciona un mapa de bits adaptable con IconCompat.createWithAdaptiveBitmap().

Asegúrate de que los mapas de bits adaptables sigan los mismos lineamientos y dimensiones establecidos para los íconos adaptables. La forma más común de lograrlo es ajustar el mapa de bits cuadrado pretendido a 72 x 72 dp y centrarlo dentro de un recuadro transparente de 108 x 108 dp. Si tu ícono incluye regiones transparentes, debes incluir un color de fondo. De lo contrario, las regiones transparentes aparecerán en negro.

No proporciones imágenes enmascaradas en una forma específica. Por ejemplo, antes de Android 10 (nivel de API 29), era común proporcionar avatares de usuarios para objetos ChooserTarget de Direct Share que estaban enmascarados en un círculo. Android Sharesheet y otras plataformas del sistema de Android 10 ahora ofrecen formas y temas para las imágenes de accesos directos. El método preferido para proporcionar accesos directos de uso compartido, a través de ShortcutManagerCompat, da forma automáticamente a los objetos ChooserTarget de Direct Share de retrocompatibilidad para círculos.

Cómo declarar un objetivo de uso compartido

Los objetivos de uso compartido deben declararse en el archivo de recursos de la app, de manera similar a las definiciones de accesos directos estáticos. Agrega definiciones de objetivos de uso compartido dentro del elemento raíz <shortcuts> en el archivo de recursos, junto con otras definiciones de accesos directos estáticos. Cada elemento <share-targets> contiene información sobre el tipo de datos compartidos, las categorías coincidentes y la clase de destino que controlará el intent de uso compartido. El código XML se ve así:

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

El elemento de datos en un objetivo de uso compartido es similar al de la especificación de datos en un filtro de intents. Cada objetivo de uso compartido puede tener varias categorías, que solo se usan para hacer coincidir los accesos directos publicados de una app con sus definiciones de objetivo de uso compartido. Las categorías pueden tener valores arbitrarios definidos por las apps.

Si el usuario selecciona un acceso directo de uso compartido en Android Sharesheet que coincide con el objetivo del ejemplo anterior, la app obtendrá el siguiente intent de uso compartido:

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 el usuario abre el objetivo de uso compartido desde los accesos directos del selector, la app obtendrá el intent que se haya creado al agregar el acceso directo de uso compartido a ShortcutManagerCompat. Como es un intent diferente, Intent.EXTRA_SHORTCUT_ID no estará disponible, por lo que tendrás que pasar el ID manualmente si lo necesitas.

Cómo informar el uso de accesos directos para apps de comunicación

Si desarrollas una app de comunicación, puedes mejorar tu clasificación en la hoja compartida de Android si informas el uso de los mensajes entrantes y salientes. Para ello, vuelve a publicar el atajo de conversación que representa al contacto a través de ShortcutManagerCompat.pushDynamicShortcut.

El uso de atajos y las vinculaciones de capacidades son retrocompatibles con Android 5.0 (nivel de API 21).

Cómo informar el uso de accesos directos para los mensajes salientes

Informar el uso de los mensajes que envía el usuario es funcionalmente similar a hacer clic en el botón "enviar" después de crear un mensaje.

Para activar los informes de uso, especifica vinculaciones de funciones en el acceso directo a través de ShortcutInfoCompat.Builder#addCapabilityBinding con la función 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 el mensaje saliente es para un chat en grupo, también debes agregar el valor del parámetro Audience, ya que el tipo recipient está asociado con la capability.

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

Cómo informar el uso de atajos para los mensajes entrantes

Para activar los informes de uso cuando el usuario recibe un mensaje, como un SMS, un mensaje de chat, un correo electrónico o notificaciones, también debes especificar las vinculaciones de capacidades en el acceso directo a través de ShortcutInfoCompat.Builder#addCapabilityBinding con la capability 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 el mensaje entrante proviene de un chat en grupo, también debes agregar el valor del parámetro Audience, ya que el tipo sender está asociado con la capability.

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

Cómo usar AndroidX para proporcionar accesos directos de uso compartido y ChooserTargets

Para poder trabajar con la biblioteca de compatibilidad de AndroidX, el manifiesto de la app debe contener el conjunto meta-data + chooser-target-service + intent-filters. Consulta la API ChooserTargetService de Direct Share actual.

Este servicio ya está declarado en la biblioteca de compatibilidad, por lo que no es necesario que el usuario lo declare en el manifiesto de la app. Sin embargo, se debe tener en cuenta el vínculo de la actividad de uso compartido con el servicio como proveedor de destino del selector.

En el siguiente ejemplo, la implementación de ChooserTargetService es androidx.core.content.pm.ChooserTargetServiceCompat y ya está definida en 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>

Preguntas frecuentes sobre accesos directos de uso compartido

¿Cómo se almacenan los datos de uso de los atajos y si salen del dispositivo?

Los atajos se almacenan por completo en el dispositivo, en el directorio de datos del sistema, en una partición de disco encriptada. Solo los servicios del sistema y la misma app que publica los atajos pueden acceder a la información de los atajos, como el ícono, la intención y los nombres de las personas y los recursos.

¿Cuál es el historial de Compartir directamente?

Presentamos Direct Share en Android 6.0 (nivel de API 23) para permitir que las apps proporcionen objetos ChooserTarget a través de un ChooserTargetService. Los resultados se recuperaban de manera reactiva a pedido, lo que hacía que los objetivos se cargaran lentamente.

En Android 10 (nivel de API 29), reemplazamos las APIs de Direct Share de ChooserTargetService por la nueva API de accesos directos de uso compartido. En lugar de obtener resultados de manera reactiva a pedido, la API de accesos directos de uso compartido permite que las apps publiquen objetivos de uso compartido directo con anticipación. Esto aceleró rápidamente el proceso de recuperación de objetivos de Direct Share cuando se preparaba ShareSheet. El mecanismo ChooserTargetService de Direct Share seguirá funcionando, pero el sistema clasifica los objetivos que se proporcionan de esta manera por debajo de cualquier objetivo que use la API de accesos directos de uso compartido.

Android 11 (nivel de API 30) dejó de admitir el servicio ChooserTargetService, y la API de accesos directos de uso compartido es la única forma de proporcionar objetivos de uso compartido directo.

¿En qué se diferencian los accesos directos publicados para objetivos de uso compartido de los accesos directos de selector (el típico uso de accesos directos por el cual se mantienen presionados los íconos de las apps en el selector)?

Los accesos directos que se publiquen para un "objetivo de uso compartido" también serán accesos directos del selector y se mostrarán en el menú cuando se mantenga presionado el ícono de tu app. El límite máximo de accesos directos por actividad también se aplica a la cantidad total de accesos directos que publica una app (incluye objetivos de uso compartido y accesos directos de selector heredados).

¿Cuál es la guía sobre la cantidad de accesos directos de uso compartido que se deben publicar?

La cantidad de atajos de uso compartido está restringida al mismo límite de atajos dinámicos disponibles a través de getMaxShortcutCountPerActivity(android.content.Context). Se puede publicar cualquier número hasta ese límite, pero se debe tener en cuenta que los accesos directos para compartir pueden estar visibles en el selector de la app con la opción de mantener presionado y en la hoja compartida. La mayoría de los selectores de apps muestran un máximo de cuatro o cinco accesos directos en modo vertical y ocho en modo horizontal cuando se mantienen presionados. Consulta estas Preguntas frecuentes para obtener más detalles y orientación sobre cómo compartir atajos.