Menerima konten lengkap

Gambar 1. API terpadu menyediakan satu tempat untuk menangani konten yang masuk dengan mengabaikan mekanisme UI tertentu, seperti menempelkan dari menu tekan lama atau menggunakan fitur tarik lalu lepas.

Pengguna menyukai gambar, video, dan konten ekspresif lainnya, tetapi memasukkan dan memindahkan konten ini di aplikasi tidaklah selalu mudah. Untuk mempermudah aplikasi menerima konten lengkap, Android 12 (API level 31) memperkenalkan API terpadu yang memungkinkan aplikasi Anda menerima konten dari sumber mana pun: papan klip, keyboard, dan tarik lalu lepas.

Anda dapat melampirkan antarmuka, OnReceiveContentListener, ke komponen UI dan mendapatkan callback saat konten disisipkan melalui mekanisme apa pun. Callback menjadi satu tempat bagi kode Anda untuk menangani penerimaan semua konten, dari teks biasa dan bergaya hingga markup, gambar, video, file audio, dan lainnya.

Untuk kompatibilitas mundur dengan versi Android sebelumnya, API ini juga tersedia di AndroidX (mulai dari Core 1.7 dan Appcompat 1.4), yang sebaiknya Anda gunakan saat mengimplementasikan fungsionalitas ini.

Ringkasan

Dengan API yang ada, setiap mekanisme UI—seperti menu tekan lama atau tarik lalu lepas—memiliki API yang sesuai. Artinya, Anda harus berintegrasi dengan setiap API secara terpisah, menambahkan kode serupa untuk setiap mekanisme yang menyisipkan konten:

Gambar 2. Sebelumnya, aplikasi Anda harus menerapkan API yang berbeda untuk setiap mekanisme UI untuk penyiapan konten.

API OnReceiveContentListener menggabungkan berbagai jalur kode dengan membuat satu API untuk diterapkan, sehingga Anda dapat berfokus pada logika khusus aplikasi dan memungkinkan platform menangani logika yang tersisa:

Gambar 3. API terpadu memungkinkan Anda mengimplementasikan satu API yang mendukung semua mekanisme UI.

Pendekatan ini juga berarti bahwa saat ada cara baru untuk menyisipkan konten yang ditambahkan ke platform, Anda tidak perlu membuat perubahan kode tambahan untuk mengaktifkan dukungan di aplikasi. Jika aplikasi perlu menerapkan penyesuaian penuh untuk kasus penggunaan tertentu, Anda masih dapat menggunakan API yang sudah ada dan akan tetap berfungsi dengan cara yang sama.

Implementasi

API adalah antarmuka pemroses dengan satu metode, OnReceiveContentListener. Untuk mendukung platform Android versi lama, sebaiknya gunakan antarmuka OnReceiveContentListener yang cocok di library AndroidX Core.

Untuk menggunakan API, mulai terapkan pemroses dengan menentukan jenis konten yang dapat ditangani oleh aplikasi Anda:

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

Setelah menentukan semua jenis MIME konten yang didukung oleh aplikasi, terapkan pemroses lainnya:

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

     @Override
     public ContentInfoCompat onReceiveContent(View view, ContentInfoCompat contentInfo) {
         Pair<ContentInfoCompat, ContentInfoCompat> 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;
     }
 }

Jika aplikasi sudah mendukung berbagi dengan Intent, Anda dapat menggunakan kembali logika khusus aplikasi untuk menangani URI konten. Tampilkan data yang tersisa untuk mendelegasikan penanganan data tersebut ke platform.

Setelah mengimplementasikan pemroses, tetapkan pada elemen UI yang sesuai di aplikasi Anda:

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

Izin URI

Izin baca diberikan dan dirilis secara otomatis oleh platform untuk setiap URI konten dalam payload yang diteruskan ke OnReceiveContentListener.

Biasanya, aplikasi Anda akan memproses URI konten dalam layanan atau aktivitas. Untuk pemrosesan yang berjalan lama, gunakan WorkManager. Saat mengimplementasikannya, Anda harus memperluas izin ke layanan atau aktivitas target dengan meneruskan konten menggunakanIntent.setClipData dan menetapkan flag FLAG_GRANT_READ_URI_PERMISSION.

Atau, Anda dapat menggunakan thread latar belakang dalam konteks saat ini untuk memproses konten. Dalam hal ini, Anda harus mempertahankan referensi ke objek payload yang diterima oleh pemroses untuk memastikan bahwa izin tidak dicabut lebih awal oleh platform.

Tampilan kustom

Jika aplikasi Anda menggunakan subclass View kustom, Anda harus memastikan bahwa OnReceiveContentListener tidak diabaikan.

Jika class View Anda menggantikan metode onCreateInputConnection, gunakan Jetpack API InputConnectionCompat.createWrapper untuk mengonfigurasi InputConnection.

Jika class View Anda menggantikan metode onTextContextMenuItem, pastikan untuk mendelegasikan ke super saat item menu R.id.paste atau R.id.pasteAsPlainText.

Perbandingan dengan keyboard image API

Anda dapat menganggap API OnReceiveContentListener sebagai versi API gambar keyboard berikutnya. API terpadu ini mendukung fungsi API gambar keyboard serta beberapa fitur tambahan. Perangkat dan kompatibilitas fitur bervariasi bergantung pada apakah Anda menggunakan library Jetpack atau API native dari Android SDK.

Fitur dan API level yang didukung: Jetpack

Tindakan atau fitur Didukung oleh API image keyboard Didukung oleh API terpadu
Sisipkan dari keyboard Ya (API level 13 dan yang lebih tinggi) Ya (API level 13 dan yang lebih tinggi)
Sisipkan menggunakan Tempel dari menu tekan lama Tidak Ya
Sisipkan menggunakan tarik lalu lepas Tidak Ya (API level 24 dan yang lebih tinggi)

Fitur dan API level yang didukung: API native

Tindakan atau fitur Didukung oleh API image keyboard Didukung oleh API terpadu
Sisipkan dari keyboard Ya (API level 25 dan yang lebih tinggi) Ya (Android 12 dan yang lebih tinggi)
Sisipkan menggunakan Tempel dari menu tekan lama Tidak
Sisipkan menggunakan tarik lalu lepas Tidak