Membuat kartu Setelan Cepat kustom untuk aplikasi Anda

Setelan Cepat adalah kartu yang ditampilkan di panel Setelan Cepat, yang mewakili tindakan, yang dapat diketuk oleh pengguna untuk menyelesaikan tugas berulang dengan cepat. Aplikasi Anda dapat menyediakan kartu kustom kepada pengguna melalui class TileService, dan menggunakan objek Tile untuk melacak status kartu. Misalnya, Anda dapat membuat kartu yang memungkinkan pengguna mengaktifkan atau menonaktifkan VPN yang disediakan oleh aplikasi Anda.

Gambar 1. Panel Setelan Cepat dengan kartu VPN diaktifkan dan dinonaktifkan.

Catatan: Panduan ini hanya membahas kartu non-Wear — Kartu Setelan Cepat tidak memiliki hubungan dengan kartu yang ditentukan dalam Wear OS. Untuk kartu Wear OS, lihat Panduan Kartu WearOS.

Menentukan kapan harus membuat kartu

Sebaiknya buat kartu untuk fungsi tertentu yang Anda harapkan akan sering diakses oleh pengguna atau memerlukan akses cepat (atau keduanya). Kartu yang paling efektif adalah kartu yang cocok dengan kedua kualitas ini, yang memberikan akses cepat ke tindakan yang sering dilakukan.

Misalnya, Anda dapat membuat kartu untuk aplikasi kebugaran yang akan memungkinkan pengguna memulai sesi olahraga dengan cepat. Namun, kami tidak akan merekomendasikan membuat kartu untuk aplikasi yang sama yang akan memungkinkan pengguna meninjau seluruh histori olahraga mereka.

Gambar 2. Contoh kartu yang direkomendasikan versus yang tidak direkomendasikan untuk aplikasi kebugaran.

Untuk membantu meningkatkan visibilitas dan kemudahan penggunaan kartu, sebaiknya hindari praktik tertentu:

• Hindari menggunakan kartu untuk meluncurkan aplikasi. Sebagai gantinya, gunakan pintasan aplikasi atau peluncur standar.

• Hindari penggunaan kartu untuk tindakan pengguna satu kali. Gunakan pintasan aplikasi atau notifikasi sebagai gantinya.

• Hindari membuat terlalu banyak kartu. Sebaiknya gunakan maksimum dua per aplikasi. Gunakan pintasan aplikasi.

• Hindari penggunaan kartu yang menampilkan informasi, tetapi tidak interaktif bagi pengguna. Gunakan notifikasi atau widget sebagai gantinya.

Membuat kartu

Untuk membuat kartu, Anda harus terlebih dahulu membuat ikon kartu yang sesuai, lalu membuat dan mendeklarasikan TileService dalam file manifes aplikasi.

Catatan: Membuat TileService untuk aplikasi Anda tidak akan menambahkannya ke panel Setelan Cepat pengguna. TileService bertindak sebagai antarmuka dengan kartu hanya setelah pengguna menambahkannya.

Contoh Setelan Cepat memberikan contoh cara membuat dan mengelola kartu.

Buat ikon khusus Anda

Anda harus menyediakan ikon kustom yang ditampilkan pada kartu di panel Setelan Cepat. (Anda akan menambahkan ikon ini saat mendeklarasikan TileService, yang dijelaskan di bagian berikutnya.) Ikon harus berwarna putih solid dengan latar belakang transparan, berukuran 24 x 24 dp, dan dalam bentuk VectorDrawable.

Gambar 3. Contoh vektor drawable.

Buat ikon yang secara visual mengisyaratkan tujuan kartu Anda. Hal ini membantu pengguna dengan mudah mengidentifikasi apakah kartu Anda sesuai dengan kebutuhan mereka. Misalnya, Anda dapat membuat ikon stopwatch untuk kartu aplikasi kebugaran yang memungkinkan pengguna memulai sesi olahraga.

Membuat dan mendeklarasikan TileService Anda

Buat layanan untuk kartu Anda yang memperluas class TileService.

Kotlin

class MyQSTileService: TileService() {

  // Called when the user adds your tile.
  override fun onTileAdded() {
    super.onTileAdded()
  }
  // Called when your app can update your tile.
  override fun onStartListening() {
    super.onStartListening()
  }

  // Called when your app can no longer update your tile.
  override fun onStopListening() {
    super.onStopListening()
  }

  // Called when the user taps on your tile in an active or inactive state.
  override fun onClick() {
    super.onClick()
  }
  // Called when the user removes your tile.
  override fun onTileRemoved() {
    super.onTileRemoved()
  }
}

Java

public class MyQSTileService extends TileService {

  // Called when the user adds your tile.
  @Override
  public void onTileAdded() {
    super.onTileAdded();
  }

  // Called when your app can update your tile.
  @Override
  public void onStartListening() {
    super.onStartListening();
  }

  // Called when your app can no longer update your tile.
  @Override
  public void onStopListening() {
    super.onStopListening();
  }

  // Called when the user taps on your tile in an active or inactive state.
  @Override
  public void onClick() {
    super.onClick();
  }

  // Called when the user removes your tile.
  @Override
  public void onTileRemoved() {
    super.onTileRemoved();
  }
}

Deklarasikan TileService di file manifes aplikasi Anda. Tambahkan nama dan label TileService, ikon khusus yang Anda buat di bagian sebelumnya, dan izin yang sesuai.

 <service
     android:name=".MyQSTileService"
     android:exported="true"
     android:label="@string/my_default_tile_label"  // 18-character limit.
     android:icon="@drawable/my_default_icon_label"
     android:permission="android.permission.BIND_QUICK_SETTINGS_TILE">
     <intent-filter>
         <action android:name="android.service.quicksettings.action.QS_TILE" />
     </intent-filter>
 </service>

Mengelola TileService Anda

Setelah membuat dan mendeklarasikan TileService di manifes aplikasi, Anda harus mengelola statusnya.

TileService adalah layanan terikat. TileService Anda akan terikat saat diminta oleh aplikasi atau jika sistem perlu berkomunikasi dengannya. Siklus proses layanan terikat standar berisi empat metode callback berikut: onCreate(), onBind(), onUnbind(), dan onDestroy(). Metode ini dipanggil oleh sistem setiap kali layanan memasuki fase siklus proses baru.

Penting: TileService Anda akan tetap melalui siklus proses Service umum. Namun, TileService berbeda dengan sebagian besar layanan terikat lainnya karena berisi metode siklus proses khusus TileService yang harus ditanggapi aplikasi Anda.

Ringkasan siklus proses TileService

Selain callback yang mengontrol siklus proses layanan terikat, Anda juga harus mengimplementasikan metode lain yang dikhususkan untuk siklus proses TileService. Metode ini dapat dipanggil di luar onCreate() dan onDestroy() karena metode siklus proses Service dan metode siklus proses TileService dipanggil dalam dua thread asinkron terpisah.

Siklus proses TileService berisi metode berikut, yang dipanggil oleh sistem setiap kali TileService memasuki fase siklus proses baru:

• onTileAdded(): Metode ini hanya dipanggil saat pengguna menambahkan kartu untuk pertama kalinya, dan jika pengguna menghapus dan menambahkan kartu lagi. Ini adalah waktu terbaik untuk melakukan inisialisasi satu kali. Namun, cara ini mungkin tidak memenuhi semua inisialisasi yang diperlukan.

  Catatan: onTileAdded() tidak dipanggil setiap kali kartu dibuat. Misalnya, onTileAdded() tidak dipanggil saat perangkat dimulai ulang atau dinyalakan jika kartu telah ditambahkan dan tidak dihapus sebelum perangkat dimatikan.

• onStartListening() dan onStopListening(): Metode ini dipanggil setiap kali aplikasi Anda memperbarui kartu, dan sering dipanggil. TileService tetap terikat antara onStartListening() dan onStopListening(), sehingga memungkinkan aplikasi Anda mengubah kartu dan mengirim update.

• onTileRemoved(): Metode ini hanya dipanggil jika pengguna menghapus kartu Anda.

Perhatian: Fase ini mungkin tidak terjadi secara berurutan. onTileAdded() hanya dapat dipanggil sekali saat kartu ditambahkan oleh pengguna ke panel Setelan Cepat. onStartListening() dan onStopListening() dapat dipanggil beberapa kali selama siklus proses TileService. onTileRemoved() tidak akan pernah dipanggil jika pengguna tidak menghapus kartu Anda dari panel Setelan Cepat.

Memilih mode mendengarkan

TileService Anda mendengarkan dalam mode aktif atau mode nonaktif. Sebaiknya gunakan mode aktif, yang perlu Anda deklarasikan dalam manifes aplikasi. Jika tidak, TileService adalah mode standar dan tidak perlu dideklarasikan.

Jangan berasumsi TileService akan aktif di luar pasangan metode onStartListening() dan onStopListening().

Mode aktif (direkomendasikan)

Gunakan mode aktif untuk TileService yang memproses dan memantau statusnya dalam prosesnya sendiri. TileService dalam mode aktif terikat untuk onTileAdded(), onTileRemoved(), peristiwa ketuk, dan jika diminta oleh proses aplikasi.

Sebaiknya gunakan mode aktif jika TileService Anda diberi tahu saat status kartu harus diperbarui oleh prosesnya sendiri. Kartu aktif membatasi ketegangan pada sistem karena tidak perlu terikat setiap kali panel Setelan Cepat terlihat oleh pengguna.

Metode TileService.requestListeningState() statis dapat dipanggil untuk meminta dimulainya status pemrosesan dan menerima callback ke onStartListening().

Anda dapat mendeklarasikan mode aktif dengan menambahkan META_DATA_ACTIVE_TILE ke file manifes aplikasi.

<service ...>
    <meta-data android:name="android.service.quicksettings.ACTIVE_TILE"
         android:value="true" />
    ...
</service>

Mode nonaktif

Mode nonaktif adalah mode standar. TileService berada dalam mode nonaktif jika terikat setiap kali kartu Anda dapat dilihat oleh pengguna. Artinya, TileService Anda dapat dibuat dan diikat lagi pada saat-saat di luar kendalinya. Elemen ini juga dapat dilepas dan dihancurkan saat pengguna tidak melihat kartu.

Aplikasi Anda menerima callback ke onStartListening() setelah pengguna membuka panel Setelan Cepat. Anda dapat memperbarui objek Tile sebanyak yang Anda inginkan antara onStartListening() dan onStopListening().

Perhatian: Jika Anda menggunakan mode nonaktif, bukan mode aktif, TileService mungkin akan diikat setiap kali pengguna membuka panel Setelan Cepat.

Anda tidak perlu mendeklarasikan mode non-aktif—cukup jangan tambahkan META_DATA_ACTIVE_TILE ke file manifes aplikasi Anda.

Ringkasan status kartu

Setelah pengguna menambahkannya, kartu Anda akan selalu ada dalam salah satu status berikut.

• STATE_ACTIVE: Menunjukkan status aktif atau diaktifkan. Pengguna dapat berinteraksi dengan kartu Anda saat dalam status ini.

  Misalnya, untuk kartu aplikasi kebugaran yang memungkinkan pengguna memulai sesi olahraga berjangka waktu, STATE_ACTIVE berarti pengguna telah memulai sesi olahraga dan timer sedang berjalan.

• STATE_INACTIVE: Menunjukkan status nonaktif atau dijeda. Pengguna dapat berinteraksi dengan kartu Anda saat dalam status ini.

  Untuk menggunakan contoh kartu aplikasi kebugaran lagi, kartu di STATE_INACTIVE akan berarti bahwa pengguna belum memulai sesi olahraga, tetapi dapat melakukannya jika mereka menginginkannya.

• STATE_UNAVAILABLE: Menunjukkan status tidak tersedia untuk sementara. Pengguna tidak dapat berinteraksi dengan kartu Anda saat dalam status ini.

  Misalnya, kartu di STATE_UNAVAILABLE berarti kartu saat ini tidak tersedia bagi pengguna karena beberapa alasan.

  Perhatian: Gunakan STATE_UNAVAILABLE untuk kartu yang saat ini tidak tersedia, tetapi dapat diubah ke status tersedia nanti. Jika komponen tidak akan tersedia lagi untuk pengguna, teruskan COMPONENT_ENABLED_STATE_DISABLED ke setComponentEnabledSetting().

Sistem hanya menetapkan status awal objek Tile Anda. Anda menetapkan status objek Tile sepanjang sisa siklus prosesnya.

Sistem dapat menambahkan warna pada ikon kartu dan latar belakang untuk mencerminkan status objek Tile Anda. Objek Tile yang ditetapkan ke STATE_ACTIVE adalah yang paling gelap, dengan STATE_INACTIVE dan STATE_UNAVAILABLE semakin terang. Rona yang tepat bersifat spesifik untuk produsen dan versinya.

Gambar 4. Contoh kartu yang diberi warna untuk mencerminkan status kartu (masing-masing status aktif, tidak aktif, dan tidak tersedia).

Memperbarui kartu Anda

Anda dapat memperbarui kartu setelah menerima callback ke onStartListening(). Bergantung pada mode kartu, kartu Anda dapat diperbarui minimal sekali hingga menerima callback ke onStopListening().

Dalam mode aktif, Anda dapat memperbarui kartu tepat satu kali sebelum menerima callback ke onStopListening(). Dalam mode nonaktif, Anda dapat memperbarui kartu sesering yang Anda inginkan antara onStartListening() dan onStopListening().

Catatan: Mode aktif memungkinkan Anda memperbarui kartu, terlepas dari apakah kartu dapat dilihat oleh pengguna atau tidak.

Anda dapat mengambil objek Tile dengan memanggil getQsTile(). Untuk memperbarui kolom tertentu dari objek Tile Anda, panggil metode berikut:

• setContentDescription()
• setIcon()
• setLabel()
• setState()
• setStateDescription()
• setSubtitle()

Catatan: Ikon dan label yang ditetapkan dalam file manifes aplikasi adalah nilai default yang ditampilkan pada kartu di panel Setelan Cepat. Namun, Anda dapat memanggil metode setIcon() dan setLabel() saat memperbarui kartu untuk menetapkan kolom ke nilai baru.

Anda harus memanggil updateTile() untuk memperbarui kartu setelah selesai menetapkan kolom objek Tile ke nilai yang benar. Tindakan ini akan membuat sistem mengurai data kartu yang diperbarui dan mengupdate UI.

Kotlin

data class StateModel(val enabled: Boolean, val label: String, val icon: Icon)

override fun onStartListening() {
  super.onStartListening()
  val state = getStateFromService()
  qsTile.label = state.label
  qsTile.contentDescription = tile.label
  qsTile.state = if (state.enabled) Tile.STATE_ACTIVE else Tile.STATE_INACTIVE
  qsTile.icon = state.icon
  qsTile.updateTile()
}

Java

public class StateModel {
  final boolean enabled;
  final String label;
  final Icon icon;

  public StateModel(boolean e, String l, Icon i) {
    enabled = e;
    label = l;
    icon = i;
  }
}

@Override
public void onStartListening() {
  super.onStartListening();
  StateModel state = getStateFromService();
  Tile tile = getQsTile();
  tile.setLabel(state.label);
  tile.setContentDescription(state.label);
  tile.setState(state.enabled ? Tile.STATE_ACTIVE : Tile.STATE_INACTIVE);
  tile.setIcon(state.icon);
  tile.updateTile();
}

Menangani ketukan

Pengguna dapat mengetuk kartu untuk memicu tindakan jika kartu Anda berada di STATE_ACTIVE atau STATE_INACTIVE. Sistem kemudian akan memanggil callback onClick() aplikasi Anda.

Setelah menerima callback ke onClick(), aplikasi Anda dapat meluncurkan dialog atau aktivitas, memicu pekerjaan latar belakang, atau mengubah status kartu.

Kotlin

var clicks = 0
override fun onClick() {
  super.onClick()
  counter++
  qsTile.state = if (counter % 2 == 0) Tile.STATE_ACTIVE else Tile.STATE_INACTIVE
  qsTile.label = "Clicked $counter times"
  qsTile.contentDescription = qsTile.label
  qsTile.updateTile()
}

Java

int clicks = 0;

@Override
public void onClick() {
  super.onClick();
  counter++;
  Tile tile = getQsTile();
  tile.setState((counter % 2 == 0) ? Tile.STATE_ACTIVE : Tile.STATE_INACTIVE);
  tile.setLabel("Clicked " + counter + " times");
  tile.setContentDescription(tile.getLabel());
  tile.updateTile();
}

Meluncurkan dialog

showDialog() menciutkan panel Setelan Cepat dan menampilkan dialog. Gunakan dialog untuk menambahkan konteks ke tindakan Anda jika tindakan tersebut memerlukan input tambahan atau izin pengguna.

Catatan: isLocked() memeriksa apakah layar kunci pengguna ditampilkan. Jika isLocked() menampilkan nilai benar (true), showDialog() tidak akan menampilkan dialog yang terlihat karena dimuat di bawah layar kunci.

Meluncurkan aktivitas

startActivityAndCollapse() memulai aktivitas saat menciutkan panel. Aktivitas akan berguna jika ada informasi yang lebih mendetail untuk ditampilkan daripada dalam dialog, atau jika tindakan Anda sangat interaktif.

Jika aplikasi Anda memerlukan interaksi pengguna yang signifikan, aplikasi harus meluncurkan aktivitas hanya sebagai upaya terakhir. Sebagai gantinya, pertimbangkan untuk menggunakan dialog atau tombol.

Dengan mengetuk lama kartu, pengguna akan melihat layar Info Aplikasi. Untuk mengganti perilaku ini dan meluncurkan aktivitas untuk menyetel preferensi, tambahkan <intent-filter> ke salah satu aktivitas Anda dengan ACTION_QS_TILE_PREFERENCES.

Mulai Android API 28, PendingIntent harus memiliki Intent.FLAG_ACTIVITY_NEW_TASK:

if (Build.VERSION.SDK_INT >= 28) {
    intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
}

Atau, Anda dapat menambahkan flag di AndroidManifest.xml di bagian Activity tertentu.

Menandai kartu Anda sebagai dapat dialihkan

Sebaiknya tandai kartu Anda sebagai dapat diganti-ganti jika fungsinya terutama sebagai tombol dua status (yang merupakan perilaku kartu yang paling umum). Hal ini membantu memberikan informasi tentang perilaku kartu ke sistem operasi dan meningkatkan aksesibilitas secara keseluruhan.

Setel metadata TOGGLEABLE_TILE ke true untuk menandai kartu Anda sebagai dapat diganti-ganti.

<service ...>
  <meta-data android:name="android.service.quicksettings.TOGGLEABLE_TILE"
    android:value="true" />
</service>

Hanya lakukan tindakan aman pada perangkat yang terkunci dengan aman

Kartu Anda mungkin ditampilkan di atas layar kunci pada perangkat yang terkunci. Jika kartu berisi informasi sensitif, periksa nilai isSecure() untuk menentukan apakah perangkat dalam status aman, dan TileService harus mengubah perilakunya sebagaimana mestinya.

Jika tindakan kartu aman dilakukan saat terkunci, gunakan startActivity() untuk meluncurkan aktivitas di atas layar kunci.

Jika tindakan kartu tidak aman, gunakan unlockAndRun() untuk meminta pengguna membuka kunci perangkat. Jika berhasil, sistem akan mengeksekusi objek Runnable yang Anda teruskan ke metode ini.

Meminta pengguna untuk menambahkan kartu

Untuk menambahkan kartu secara manual, pengguna harus mengikuti beberapa langkah:

1. Geser ke bawah untuk membuka panel Setelan Cepat.
2. Ketuk tombol edit.
3. Men-scroll semua kartu di perangkat mereka sampai mereka menemukan kartu Anda.
4. Tahan kotak Anda, dan seret ke daftar kotak yang aktif.

Pengguna juga dapat memindahkan atau menghapus kartu kapan saja.

Mulai Android 13, Anda dapat menggunakan metode requestAddTileService() untuk mempermudah pengguna menambahkan kartu ke perangkat. Metode ini akan meminta pengguna untuk menambahkan kartu Anda dengan cepat langsung ke panel Setelan Cepat. Perintah tersebut menyertakan nama aplikasi, label, dan ikon yang disediakan.

Gambar 5. Dialog Quick Settings Placement API.

public void requestAddTileService (
  ComponentName tileServiceComponentName,
  CharSequence tileLabel,
  Icon icon,
  Executor resultExecutor,
  Consumer<Integer> resultCallback
)

Callback berisi informasi tentang apakah kartu telah ditambahkan atau tidak ditambahkan, apakah kartu sudah ada di sana atau tidak, atau apakah terjadi error.

Gunakan pertimbangan Anda saat menentukan waktu dan frekuensi untuk meminta izin kepada pengguna. Sebaiknya panggil requestAddTileService() hanya dalam konteks – seperti saat pengguna pertama kali berinteraksi dengan fitur yang difasilitasi kartu Anda.

Sistem dapat memilih untuk berhenti memproses permintaan untuk ComponentName tertentu jika telah ditolak oleh pengguna cukup kali sebelumnya. Pengguna ditentukan dari Context yang digunakan untuk mengambil layanan ini, yang harus cocok dengan pengguna saat ini.

Catatan: Sebaiknya panggil requestAddTileService() untuk meningkatkan visibilitas kartu dan mengurangi beban pengguna untuk menambahkan kartu ke panel Setelan Cepat mereka.