Tạo ô Cài đặt nhanh tuỳ chỉnh cho ứng dụng

Cài đặt nhanh là các thẻ thông tin hiển thị trong bảng điều khiển Cài đặt nhanh, đại diện cho các thao tác mà người dùng có thể nhấn vào để nhanh chóng hoàn tất các tác vụ định kỳ. Ứng dụng của bạn có thể cung cấp thẻ thông tin tuỳ chỉnh cho người dùng thông qua lớp TileService và sử dụng đối tượng Tile để theo dõi trạng thái của thẻ thông tin. Ví dụ: bạn có thể tạo một thẻ thông tin cho phép người dùng bật hoặc tắt VPN do ứng dụng của bạn cung cấp.

Bảng điều khiển Cài đặt nhanh với ô VPN bật và tắt
Hình 1. Bảng điều khiển Cài đặt nhanh với ô VPN bật và tắt.

Quyết định thời điểm tạo thẻ thông tin

Bạn nên tạo thẻ thông tin cho các chức năng cụ thể mà bạn cho rằng người dùng sẽ truy cập thường xuyên hoặc cần truy cập nhanh (hoặc cả hai). Thẻ thông tin hiệu quả nhất là những thẻ thông tin phù hợp với cả hai phẩm chất này, giúp bạn truy cập nhanh vào các thao tác thường thực hiện.

Ví dụ: bạn có thể tạo thẻ thông tin cho một ứng dụng thể dục để cho phép người dùng nhanh chóng bắt đầu một phiên tập thể dục. Tuy nhiên, bạn không nên tạo thẻ thông tin cho cùng một ứng dụng cho phép người dùng xem lại toàn bộ nhật ký tập thể dục của họ.

Các trường hợp sử dụng thẻ ứng dụng thể dục
Hình 2. Ví dụ về thẻ thông tin được đề xuất và không được đề xuất cho một ứng dụng thể dục.

Để giúp tăng khả năng người dùng tìm thấy thẻ thông tin và dễ dàng sử dụng thẻ thông tin, bạn nên tránh một số phương pháp sau:

  • Tránh sử dụng thẻ thông tin để chạy ứng dụng. Thay vào đó, hãy sử dụng lối tắt ứng dụng hoặc trình chạy tiêu chuẩn.

  • Tránh sử dụng thẻ thông tin cho các hành động một lần của người dùng. Thay vào đó, hãy sử dụng lối tắt ứng dụng hoặc thông báo.

  • Tránh tạo quá nhiều thẻ thông tin. Bạn nên đặt tối đa 2 lối tắt cho mỗi ứng dụng. Thay vào đó, hãy sử dụng lối tắt ứng dụng.

  • Tránh sử dụng thẻ thông tin hiển thị thông tin nhưng không tương tác với người dùng. Thay vào đó, hãy sử dụng thông báo hoặc tiện ích.

Tạo thẻ thông tin

Để tạo thẻ thông tin, trước tiên, bạn cần tạo một biểu tượng thẻ thông tin thích hợp, sau đó tạo và khai báo TileService trong tệp kê khai của ứng dụng.

Mẫu Cài đặt nhanh cung cấp ví dụ về cách tạo và quản lý thẻ thông tin.

Tạo biểu tượng tuỳ chỉnh

Bạn cần cung cấp một biểu tượng tuỳ chỉnh. Biểu tượng này sẽ hiển thị trên ô trong bảng điều khiển Cài đặt nhanh. (Bạn sẽ thêm biểu tượng này khi khai báo TileService, được mô tả trong phần tiếp theo.) Biểu tượng phải có màu trắng trơn với nền trong suốt, kích thước 24 x 24 dp và ở dạng VectorDrawable.

Ví dụ về vectơ vẽ được
Hình 3. Ví dụ về một vectơ có thể vẽ.

Tạo một biểu tượng gợi ý về mục đích của thẻ thông tin. Điều này giúp người dùng dễ dàng xác định xem thẻ thông tin của bạn có phù hợp với nhu cầu của họ hay không. Ví dụ: bạn có thể tạo biểu tượng đồng hồ bấm giờ cho thẻ thông tin của một ứng dụng thể dục cho phép người dùng bắt đầu một phiên tập thể dục.

Tạo và khai báo TileService

Tạo một dịch vụ cho thẻ thông tin mở rộng lớp 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();
  }
}

Khai báo TileService trong tệp kê khai của ứng dụng. Thêm tên và nhãn của TileService, biểu tượng tuỳ chỉnh mà bạn đã tạo trong phần trước và quyền thích hợp.

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

Quản lý TileService

Sau khi tạo và khai báo TileService trong tệp kê khai ứng dụng, bạn phải quản lý trạng thái của tệp này.

TileService là một dịch vụ liên kết. TileService được liên kết khi ứng dụng của bạn yêu cầu hoặc nếu hệ thống cần giao tiếp với ứng dụng đó. Một vòng đời dịch vụ liên kết thông thường chứa 4 phương thức gọi lại sau: onCreate(), onBind(), onUnbind() và onDestroy(). Hệ thống sẽ gọi các phương thức này mỗi khi dịch vụ chuyển sang một giai đoạn vòng đời mới.

Tổng quan về vòng đời của TileService

Ngoài các lệnh gọi lại kiểm soát vòng đời của dịch vụ liên kết, bạn phải triển khai các phương thức khác dành riêng cho vòng đời TileService. Bạn có thể gọi các phương thức này bên ngoài onCreate() và onDestroy() vì các phương thức vòng đời Service và các phương thức vòng đời TileService được gọi trong hai luồng không đồng bộ riêng biệt.

Vòng đời TileService chứa các phương thức sau đây, được hệ thống gọi mỗi khi TileService của bạn chuyển sang một giai đoạn vòng đời mới:

  • onTileAdded(): Phương thức này chỉ được gọi khi người dùng thêm thẻ thông tin của bạn lần đầu tiên và nếu người dùng xoá rồi thêm lại thẻ thông tin của bạn. Đây là thời điểm tốt nhất để thực hiện mọi hoạt động khởi chạy một lần. Tuy nhiên, điều này có thể không đáp ứng được tất cả các yêu cầu khởi chạy cần thiết.

  • onStartListening() và onStopListening(): Các phương thức này được gọi mỗi khi ứng dụng của bạn cập nhật thẻ thông tin và thường được gọi. TileService vẫn liên kết giữa onStartListening() và onStopListening(), cho phép ứng dụng của bạn sửa đổi thẻ thông tin và đẩy nội dung cập nhật.

  • onTileRemoved(): Phương thức này chỉ được gọi nếu người dùng xoá thẻ thông tin của bạn.

Chọn chế độ nghe

TileService của bạn sẽ nghe ở chế độ đang hoạt động hoặc chế độ không hoạt động. Bạn nên sử dụng chế độ đang hoạt động. Bạn cần khai báo chế độ này trong tệp kê khai ứng dụng. Nếu không, TileService là chế độ chuẩn và không cần khai báo.

Đừng giả định rằng TileService sẽ nằm ngoài cặp phương thức onStartListening() và onStopListening().

Sử dụng chế độ đang hoạt động cho TileService để nghe và theo dõi trạng thái của TileService trong quy trình của chính TileService. TileService ở chế độ đang hoạt động được liên kết với onTileAdded(), onTileRemoved(), các sự kiện nhấn và khi quy trình ứng dụng yêu cầu.

Bạn nên sử dụng chế độ đang hoạt động nếu TileService của bạn được thông báo khi trạng thái thẻ thông tin sẽ được cập nhật theo quy trình riêng. Thẻ thông tin đang hoạt động giới hạn mức độ căng thẳng trên hệ thống vì người dùng không cần phải liên kết thẻ thông tin mỗi khi bảng điều khiển Cài đặt nhanh hiển thị.

Bạn có thể gọi phương thức TileService.requestListeningState() tĩnh để yêu cầu bắt đầu trạng thái nghe và nhận lệnh gọi lại đến onStartListening().

Bạn có thể khai báo chế độ đang hoạt động bằng cách thêm META_DATA_ACTIVE_TILE vào tệp kê khai của ứng dụng.

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

Chế độ không hoạt động

Chế độ không hoạt động là chế độ tiêu chuẩn. TileService ở chế độ không hoạt động nếu được liên kết bất cứ khi nào người dùng nhìn thấy thẻ thông tin của bạn. Điều này có nghĩa là TileService có thể được tạo và liên kết lại vào những thời điểm nằm ngoài tầm kiểm soát của nó. Thẻ thông tin này cũng có thể bị huỷ liên kết và bị huỷ khi người dùng không xem thẻ thông tin.

Ứng dụng của bạn sẽ nhận được lệnh gọi lại đến onStartListening() sau khi người dùng mở bảng điều khiển Cài đặt nhanh. Bạn có thể cập nhật đối tượng Tile bao nhiêu lần tuỳ thích trong khoảng thời gian từ onStartListening() đến onStopListening().

Bạn không cần khai báo chế độ không hoạt động – chỉ cần không thêm META_DATA_ACTIVE_TILE vào tệp kê khai của ứng dụng.

Tổng quan về trạng thái thẻ thông tin

Sau khi người dùng thêm thẻ thông tin, thẻ thông tin đó luôn tồn tại ở một trong các trạng thái sau.

  • STATE_ACTIVE: Cho biết trạng thái bật hoặc đã bật. Người dùng có thể tương tác với thẻ thông tin của bạn khi ở trạng thái này.

    Ví dụ: đối với thẻ thông tin ứng dụng thể dục cho phép người dùng bắt đầu một phiên tập thể dục theo thời gian, STATE_ACTIVE có nghĩa là người dùng đã bắt đầu một phiên tập thể dục và đồng hồ hẹn giờ đang chạy.

  • STATE_INACTIVE: Cho biết trạng thái tắt hoặc tạm dừng. Người dùng có thể tương tác với thẻ thông tin của bạn khi ở trạng thái này.

    Để sử dụng lại ví dụ về thẻ thông tin ứng dụng thể dục, thẻ thông tin trong STATE_INACTIVE sẽ có nghĩa là người dùng chưa bắt đầu một phiên tập thể dục, nhưng có thể làm như vậy nếu họ muốn.

  • STATE_UNAVAILABLE: Cho biết trạng thái tạm thời không có sẵn. Người dùng không thể tương tác với thẻ thông tin của bạn khi ở trạng thái này.

    Ví dụ: thẻ thông tin trong STATE_UNAVAILABLE có nghĩa là thẻ thông tin đó hiện không có sẵn cho người dùng vì một số lý do.

Hệ thống chỉ đặt trạng thái ban đầu của đối tượng Tile. Bạn đặt trạng thái của đối tượng Tile trong suốt phần còn lại của vòng đời.

Hệ thống có thể phủ màu cho biểu tượng thẻ thông tin và nền để phản ánh trạng thái của đối tượng Tile. Các đối tượng Tile được đặt thành STATE_ACTIVE là tối nhất, với STATE_INACTIVE và STATE_UNAVAILABLE ngày càng sáng hơn. Sắc độ chính xác là dành riêng cho nhà sản xuất và phiên bản.

Thẻ thông tin VPN được tô màu để phản ánh trạng thái của đối tượng
Hình 4. Ví dụ về thẻ thông tin được phủ màu để phản ánh trạng thái của thẻ thông tin (tương ứng là trạng thái đang hoạt động, không hoạt động và không có sẵn).

Cập nhật thẻ thông tin

Bạn có thể cập nhật thẻ thông tin sau khi nhận được lệnh gọi lại đến onStartListening(). Tuỳ thuộc vào chế độ của thẻ thông tin, thẻ thông tin của bạn có thể được cập nhật ít nhất một lần cho đến khi nhận được lệnh gọi lại đến onStopListening().

Ở chế độ đang hoạt động, bạn có thể cập nhật thẻ thông tin một lần chính xác trước khi nhận được lệnh gọi lại đến onStopListening(). Ở chế độ không hoạt động, bạn có thể cập nhật thẻ thông tin của mình nhiều lần như mong muốn giữa onStartListening() và onStopListening().

Bạn có thể truy xuất đối tượng Tile bằng cách gọi getQsTile(). Để cập nhật các trường cụ thể của đối tượng Tile, hãy gọi các phương thức sau:

Bạn phải gọi updateTile() để cập nhật thẻ thông tin sau khi đặt xong các trường của đối tượng Tile thành các giá trị chính xác. Thao tác này sẽ giúp hệ thống phân tích cú pháp dữ liệu thẻ thông tin đã cập nhật và cập nhật giao diện người dùng.

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

Xử lý thao tác nhấn

Người dùng có thể nhấn vào thẻ thông tin của bạn để kích hoạt một hành động nếu thẻ thông tin của bạn ở trong STATE_ACTIVE hoặc STATE_INACTIVE. Sau đó, hệ thống sẽ gọi lệnh gọi lại onClick() của ứng dụng.

Sau khi nhận được lệnh gọi lại đến onClick(), ứng dụng của bạn có thể chạy một hộp thoại hoặc hoạt động, kích hoạt công việc trong nền hoặc thay đổi trạng thái của thẻ thông tin.

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

Chạy hộp thoại

showDialog() thu gọn bảng Cài đặt nhanh và hiển thị một hộp thoại. Sử dụng hộp thoại để thêm ngữ cảnh vào hành động của bạn nếu hành động đó yêu cầu thêm thông tin đầu vào hoặc sự đồng ý của người dùng.

Chạy một hoạt động

startActivityAndCollapse() bắt đầu một hoạt động trong khi thu gọn bảng điều khiển. Hoạt động sẽ hữu ích nếu có nhiều thông tin chi tiết hơn để hiển thị trong hộp thoại hoặc nếu hành động của bạn có tính tương tác cao.

Nếu ứng dụng của bạn yêu cầu người dùng tương tác đáng kể, thì ứng dụng chỉ nên chạy một hoạt động như một phương án cuối cùng. Thay vào đó, hãy cân nhắc sử dụng hộp thoại hoặc nút bật/tắt.

Thao tác nhấn và giữ một thẻ thông tin sẽ hiển thị màn hình Thông tin ứng dụng cho người dùng. Để ghi đè hành vi này và thay vào đó, hãy chạy một hoạt động để đặt lựa chọn ưu tiên, hãy thêm <intent-filter> vào một trong các hoạt động của bạn bằng ACTION_QS_TILE_PREFERENCES.

Kể từ Android API 28, PendingIntent phải có Intent.FLAG_ACTIVITY_NEW_TASK:

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

Ngoài ra, bạn có thể thêm cờ trong AndroidManifest.xml trong phần Activity cụ thể.

Đánh dấu thẻ thông tin của bạn là có thể bật/tắt

Bạn nên đánh dấu thẻ thông tin là có thể bật/tắt nếu thẻ đó chủ yếu hoạt động như một nút chuyển hai trạng thái (đây là hành vi phổ biến nhất của thẻ thông tin). Điều này giúp cung cấp thông tin về hành vi của thẻ thông tin cho hệ điều hành và cải thiện khả năng hỗ trợ tiếp cận tổng thể.

Đặt siêu dữ liệu TOGGLEABLE_TILE thành true để đánh dấu thẻ thông tin của bạn là có thể bật/tắt.

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

Chỉ thực hiện các thao tác an toàn trên thiết bị được khoá an toàn

Thẻ thông tin của bạn có thể hiển thị ở đầu màn hình khoá trên các thiết bị đã khoá. Nếu thẻ thông tin chứa thông tin nhạy cảm, hãy kiểm tra giá trị của isSecure() để xác định xem thiết bị có ở trạng thái an toàn hay không và TileService sẽ thay đổi hành vi của nó cho phù hợp.

Nếu bạn có thể thực hiện thao tác trên thẻ thông tin một cách an toàn khi màn hình đang khoá, hãy sử dụng startActivity() để chạy một hoạt động trên màn hình khoá.

Nếu thao tác trên thẻ thông tin không an toàn, hãy sử dụng unlockAndRun() để nhắc người dùng mở khoá thiết bị. Nếu thành công, hệ thống sẽ thực thi đối tượng Runnable mà bạn truyền vào phương thức này.

Nhắc người dùng thêm thẻ thông tin

Để thêm thẻ thông tin theo cách thủ công, người dùng phải làm theo một số bước:

  1. Vuốt xuống để mở bảng Cài đặt nhanh.
  2. Nhấn vào nút chỉnh sửa.
  3. Di chuyển qua tất cả thẻ thông tin trên thiết bị của họ cho đến khi họ tìm thấy thẻ thông tin của bạn.
  4. Giữ ô rồi kéo ô đó vào danh sách ô đang hoạt động.

Người dùng cũng có thể di chuyển hoặc xoá thẻ thông tin của bạn bất cứ lúc nào.

Kể từ Android 13, bạn có thể sử dụng phương thức requestAddTileService() để giúp người dùng dễ dàng thêm thẻ thông tin vào thiết bị hơn. Phương thức này sẽ nhắc người dùng thêm trực tiếp thẻ thông tin của bạn vào bảng điều khiển Cài đặt nhanh. Lời nhắc này bao gồm tên ứng dụng, nhãn và biểu tượng được cung cấp.

Lời nhắc về API Vị trí cài đặt nhanh
Hình 5. Lời nhắc về API Vị trí cài đặt nhanh.
public void requestAddTileService (
  ComponentName tileServiceComponentName,
  CharSequence tileLabel,
  Icon icon,
  Executor resultExecutor,
  Consumer<Integer> resultCallback
)

Lệnh gọi lại chứa thông tin về việc thẻ thông tin có được thêm hay không, không được thêm, đã có hay chưa hoặc có lỗi nào xảy ra hay không.

Hãy cân nhắc kỹ khi quyết định thời điểm và tần suất nhắc người dùng. Bạn chỉ nên gọi requestAddTileService() trong ngữ cảnh – chẳng hạn như khi người dùng tương tác lần đầu với một tính năng mà thẻ thông tin của bạn hỗ trợ.

Hệ thống có thể chọn ngừng xử lý các yêu cầu cho một ComponentName nhất định nếu người dùng đã từ chối yêu cầu đó đủ lần trước đó. Người dùng được xác định từ Context dùng để truy xuất dịch vụ này – người dùng phải khớp với người dùng hiện tại.