Membangun host widget

Layar utama Android, yang tersedia di sebagian besar perangkat yang didukung Android, memungkinkan pengguna menyematkan widget aplikasi (atau widget) untuk akses cepat ke konten. Jika mem-build pengganti layar utama atau aplikasi serupa, Anda juga dapat mengizinkan pengguna menyematkan widget dengan menerapkan AppWidgetHost. Hal ini tidak perlu dilakukan oleh sebagian besar aplikasi, tetapi jika Anda membuat host sendiri, sebaiknya pahami kewajiban kontraktual yang disetujui host secara implisit.

Halaman ini berfokus pada tanggung jawab yang termasuk dalam penerapan AppWidgetHost kustom. Untuk contoh spesifik cara menerapkan AppWidgetHost, lihat kode sumber untuk layar utama Android LauncherAppWidgetHost.

Berikut adalah ringkasan class dan konsep utama yang terlibat dalam penerapan AppWidgetHost kustom:

  • Host widget aplikasi: AppWidgetHost menyediakan interaksi dengan layanan AppWidget untuk aplikasi yang menyematkan widget dalam UI-nya. AppWidgetHost harus memiliki ID yang unik dalam paket host sendiri. ID ini akan dipertahankan di seluruh penggunaan host. ID biasanya berupa nilai hardcode yang Anda tetapkan di aplikasi.

  • ID widget aplikasi: setiap instance widget diberi ID unik pada saat binding. Lihat bindAppWidgetIdIfAllowed() dan, untuk mengetahui detail selengkapnya, lihat bagian Mengikat widget berikut. Host mendapatkan ID unik menggunakan allocateAppWidgetId(). ID ini akan tetap ada selama masa aktif widget hingga dihapus dari host. Setiap status khusus host—seperti ukuran dan lokasi widget—harus dipertahankan oleh paket hosting dan dikaitkan dengan ID widget aplikasi.

  • Tampilan host widget aplikasi: anggap AppWidgetHostView sebagai bingkai yang menggabungkan widget setiap kali perlu ditampilkan. Widget dikaitkan dengan AppWidgetHostView setiap kali widget di-inflate oleh host.

    • Secara default, sistem membuat AppWidgetHostView, tetapi host dapat membuat subclass AppWidgetHostView-nya sendiri dengan memperluasnya.
    • Mulai Android 12 (API level 31), AppWidgetHostView memperkenalkan metode setColorResources() dan resetColorResources() untuk menangani warna yang di-overload secara dinamis. Host bertanggung jawab untuk menyediakan warna ke metode ini.

  • Paket opsi: AppWidgetHost menggunakan paket opsi untuk menyampaikan informasi ke AppWidgetProvider tentang cara widget ditampilkan—misalnya, daftar rentang ukuran—dan apakah widget berada di layar kunci atau layar utama. Informasi ini memungkinkan AppWidgetProvider menyesuaikan konten dan tampilan widget berdasarkan cara dan lokasi widget ditampilkan. Anda dapat menggunakan updateAppWidgetOptions() dan updateAppWidgetSize() untuk mengubah paket widget. Kedua metode ini memicu callback onAppWidgetOptionsChanged() ke AppWidgetProvider.

Mengikat widget

Saat pengguna menambahkan widget ke host, akan terjadi proses yang disebut binding. Binding mengacu pada pengaitan ID widget aplikasi tertentu dengan host tertentu dan AppWidgetProvider tertentu.

Binding API juga memungkinkan host menyediakan UI kustom untuk binding. Untuk menggunakan proses ini, aplikasi Anda harus mendeklarasikan izin BIND_APPWIDGET dalam manifes host:

<uses-permission android:name="android.permission.BIND_APPWIDGET" />

Namun, ini hanyalah langkah pertama. Saat runtime, pengguna harus memberikan izin secara eksplisit ke aplikasi Anda agar dapat menambahkan widget ke host. Untuk menguji apakah aplikasi Anda memiliki izin untuk menambahkan widget, gunakan metode bindAppWidgetIdIfAllowed(). Jika bindAppWidgetIdIfAllowed() menampilkan false, aplikasi Anda harus menampilkan dialog yang meminta pengguna untuk memberikan izin: "izinkan" untuk penambahan widget saat ini, atau "selalu izinkan" untuk mencakup semua penambahan widget mendatang.

Cuplikan berikut menunjukkan contoh cara menampilkan dialog:

Kotlin

val intent = Intent(AppWidgetManager.ACTION_APPWIDGET_BIND).apply {
    putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId)
    putExtra(AppWidgetManager.EXTRA_APPWIDGET_PROVIDER, info.componentName)
    // This is the options bundle described in the preceding section.
    putExtra(AppWidgetManager.EXTRA_APPWIDGET_OPTIONS, options)
}
startActivityForResult(intent, REQUEST_BIND_APPWIDGET)

Java

Intent intent = new Intent(AppWidgetManager.ACTION_APPWIDGET_BIND);
intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId);
intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_PROVIDER, info.componentName);
// This is the options bundle described in the preceding section.
intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_OPTIONS, options);
startActivityForResult(intent, REQUEST_BIND_APPWIDGET);

Host harus memeriksa apakah widget yang ditambahkan pengguna memerlukan konfigurasi. Untuk mengetahui informasi selengkapnya, lihat Memungkinkan pengguna mengonfigurasi widget aplikasi.

Tanggung jawab host

Anda dapat menentukan sejumlah setelan konfigurasi untuk widget menggunakan metadata AppWidgetProviderInfo. Anda dapat mengambil opsi konfigurasi ini, yang dibahas secara lebih mendetail di bagian berikut, dari objek AppWidgetProviderInfo yang terkait dengan penyedia widget.

Terlepas dari versi Android yang Anda targetkan, semua host memiliki tanggung jawab berikut:

  • Saat menambahkan widget, alokasikan ID widget seperti yang dijelaskan sebelumnya. Saat widget dihapus dari host, panggil deleteAppWidgetId() untuk menghapus alokasi ID widget.

  • Saat menambahkan widget, periksa apakah aktivitas konfigurasi perlu diluncurkan. Biasanya, host perlu meluncurkan aktivitas konfigurasi widget jika ada dan tidak ditandai sebagai opsional dengan menentukan flag configuration_optional dan reconfigurable. Lihat Memperbarui widget dari aktivitas konfigurasi untuk mengetahui detailnya. Langkah ini perlu dilakukan agar widget dapat ditampilkan.

  • Widget menentukan lebar dan tinggi default dalam metadata AppWidgetProviderInfo. Nilai ini ditentukan dalam sel—mulai dari Android 12, jika targetCellWidth dan targetCellHeight ditentukan—atau dps jika hanya minWidth dan minHeight yang ditentukan. Lihat Atribut ukuran widget.

    Pastikan tata letak widget setidaknya sesuai dengan ukuran dalam dp ini. Misalnya, banyak host meratakan ikon dan widget dalam formasi petak. Dalam skenario ini, secara default, host menambahkan widget menggunakan jumlah sel minimum yang memenuhi batasan minWidth dan minHeight.

Selain persyaratan yang tercantum di bagian sebelumnya, versi platform tertentu memperkenalkan fitur yang memberikan tanggung jawab baru kepada host.

Menentukan pendekatan Anda berdasarkan versi Android yang ditargetkan

Android 12

Android 12 (API level 31) memaketkan List<SizeF> tambahan yang berisi daftar kemungkinan ukuran dalam dps yang dapat diambil instance widget dalam paket opsi. Jumlah ukuran yang diberikan bergantung pada implementasi host. Penyelenggara biasanya menyediakan dua ukuran untuk ponsel—potret dan lanskap—dan empat ukuran untuk perangkat foldable.

Ada batas MAX_INIT_VIEW_COUNT (16) pada jumlah RemoteViews yang berbeda yang dapat diberikan oleh AppWidgetProvider ke RemoteViews. Karena objek AppWidgetProvider memetakan objek RemoteViews ke setiap ukuran dalam List<SizeF>, jangan berikan lebih dari ukuran MAX_INIT_VIEW_COUNT.

Android 12 juga memperkenalkan atribut maxResizeWidth dan maxResizeHeight dalam dps. Sebaiknya widget yang menggunakan setidaknya salah satu atribut ini tidak melebihi ukuran yang ditentukan oleh atribut.

Referensi lainnya

  • Lihat dokumentasi referensi Glance.