Cómo recibir contenido enriquecido

A los usuarios les encantan las imágenes, los videos y demás contenido expresivo, pero insertar y mover este contenido en apps no siempre es fácil. Para que las apps puedan recibir contenido enriquecido de manera simple, Android 12 (nivel de API 31) incorporó una API unificada que permitirá que tu app acepte contenido de cualquier fuente: portapapeles, teclado o arrastrar.

Puedes adjuntar una interfaz, como OnReceiveContentListener, a los componentes de la IU y obtener una devolución de llamada cuando se inserta contenido a través de cualquier mecanismo. La devolución de llamada se convierte en el único lugar para que tu código controle la recepción de todo el contenido, desde texto sin formato y estilo hasta lenguaje de marcado, imágenes, videos, archivos de audio y otros elementos.

Para ofrecer retrocompatibilidad con versiones anteriores de Android, esta API también está disponible en AndroidX, a partir de Core 1.7 y Appcompat 1.4, que te recomendamos que uses cuando implementes esta funcionalidad.

Descripción general

Con las otras APIs existentes, cada mecanismo de IU (como el menú de mantener presionado o arrastrar) tiene su propia API correspondiente. Eso significa que debes realizar la integración con cada API por separado, lo que agrega código similar para cada mecanismo que inserte contenido:

La API de OnReceiveContentListener consolida estas rutas de código diferentes creando una sola API para que puedas enfocarte en la lógica específica de tu app y permitir que la plataforma controle el resto:

Este enfoque también significa que, cuando se agregan nuevas formas de insertar contenido a la plataforma, no es necesario realizar cambios adicionales en el código para habilitar la compatibilidad en tu app. Y si tu app necesita implementar una personalización completa para un caso de uso en particular, puedes seguir usando las APIs existentes, que siguen funcionando de la misma manera.

Implementación

La API es una interfaz de objeto de escucha con un único método, OnReceiveContentListener. Para admitir versiones anteriores de la plataforma de Android, recomendamos el uso de la interfaz OnReceiveContentListener coincidente en la biblioteca de AndroidX Core.

Para usar la API, implementa el objeto de escucha mediante la especificación de los tipos de contenido que tu app puede controlar:

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

Después de especificar todos los tipos de MIME de contenido que admite tu app, implementa el resto del objeto de escucha:

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 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 tu app ya admite el uso compartido con intents, puedes volver a usar la lógica específica de la app para administrar los URI de contenido. Muestra los datos restantes para delegar su control a la plataforma.

Después de implementar el objeto de escucha, configúralo en los elementos de la IU adecuados de tu app:

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

Permisos de URI

La plataforma otorga y libera los permisos de lectura automáticamente para cualquier URI de contenido en la carga útil que se pasa a OnReceiveContentListener.

Normalmente, tu app procesa los URI de contenido en un servicio o una actividad. Para el procesamiento a largo plazo, usa WorkManager. Cuando implementes esto, extiende los permisos al servicio o la actividad de destino pasando el contenido con Intent.setClipData y estableciendo la marca FLAG_GRANT_READ_URI_PERMISSION.

De manera alternativa, puedes usar un subproceso en segundo plano dentro del contexto actual para procesar el contenido. En este caso, debes mantener una referencia al objeto payload que recibe el objeto de escucha para asegurarte de que la plataforma no revoque los permisos prematuramente.

Vistas personalizadas

Si tu app usa una subclase View personalizada, asegúrate de que no se omita el objeto OnReceiveContentListener.

Si tu clase View anula el método onCreateInputConnection, usa la API de Jetpack InputConnectionCompat.createWrapper para configurar InputConnection.

Si tu clase View anula el método onTextContextMenuItem, delega a super cuando el elemento de menú sea R.id.paste o R.id.pasteAsPlainText.

Comparación con la API de imagen de teclado

Puedes considerar la API de OnReceiveContentListener como la próxima versión de la API de imagen de teclado existente. Esta API unificada admite la funcionalidad de la API de imagen de teclado y algunas funciones adicionales. La compatibilidad con los dispositivos y las funciones varía según si usas la biblioteca de Jetpack o las API nativas desde el SDK de Android.