为您的应用创建自定义快速设置磁贴

快速设置是在快速设置面板中显示的磁贴，代表用户可以点击以快速完成重复性任务的操作。您的应用可以通过TileService类向用户提供自定义磁贴，并使用Tile对象跟踪磁贴的状态。例如，您可以创建一个磁贴，让用户可以打开或关闭您的应用提供的VPN。

决定何时创建磁贴

我们建议为预期用户经常访问或需要快速访问（或两者兼而有之）的特定功能创建磁贴。最有效的磁贴是同时满足这两个条件的磁贴，可以快速访问经常执行的操作。

例如，您可以为健身应用创建一个磁贴，允许用户快速开始锻炼。但是，我们不建议为同一个应用创建允许用户查看整个锻炼历史记录的磁贴。

为了帮助提高磁贴的可发现性和易用性，我们建议避免某些做法

• 避免使用磁贴来启动应用。请改用应用快捷方式或标准启动器。

• 避免对一次性用户操作使用磁贴。请改用应用快捷方式或通知。

• 避免创建过多的磁贴。我们建议每个应用最多两个。请改用应用快捷方式。

• 避免使用显示信息但对用户没有交互性的磁贴。请改用通知或小部件。

创建您的磁贴

要创建磁贴，您首先需要创建一个合适的磁贴图标，然后在应用的清单文件中创建并声明您的TileService。

快速设置示例提供了一个关于如何创建和管理磁贴的示例。

创建自定义图标

您需要提供一个自定义图标，该图标显示在快速设置面板中的磁贴上。（您将在声明TileService时添加此图标，这将在下一节中描述。）图标必须为纯白色，背景透明，尺寸为 24 x 24dp，并且必须采用VectorDrawable的形式。

创建一个直观暗示磁贴用途的图标。这有助于用户轻松识别您的磁贴是否符合他们的需求。例如，您可以为允许用户开始锻炼的健身应用磁贴创建一个秒表的图标。

创建并声明您的TileService

为您的磁贴创建一个扩展TileService类的服务。

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

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

在您的应用的清单文件中声明您的TileService。添加您的TileService的名称和标签、您在上文中创建的自定义图标以及相应的权限。

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

管理您的TileService

在应用清单中创建并声明TileService后，您必须管理其状态。

TileService是一个绑定服务。您的TileService在您的应用请求或系统需要与之通信时绑定。一个典型的绑定服务生命周期包含以下四个回调方法：onCreate()、onBind()、onUnbind()和onDestroy()。每次服务进入新的生命周期阶段时，系统都会调用这些方法。

TileService生命周期概述

除了控制绑定服务生命周期的回调之外，您还必须实现特定于TileService生命周期的其他方法。这些方法可能在onCreate()和onDestroy()之外被调用，因为Service生命周期方法和TileService生命周期方法是在两个独立的异步线程中调用的。

该TileService生命周期包含以下方法，这些方法在您的TileService进入新的生命周期阶段时由系统调用

• onTileAdded()：仅当用户第一次添加您的磁贴时以及如果用户删除并再次添加您的磁贴时，才会调用此方法。这是执行任何一次性初始化的最佳时机。但是，这可能无法满足所有必要的初始化。

• onStartListening()和onStopListening()：每当您的应用更新磁贴时，都会调用这些方法，并且经常调用。在onStartListening()和onStopListening()之间，TileService保持绑定状态，允许您的应用修改磁贴并推送更新。

• onTileRemoved()：只有当用户移除您的磁贴时，才会调用此方法。

选择监听模式

您的 TileService 以活动模式或非活动模式监听。我们建议使用活动模式，您需要在应用清单中声明它。否则，TileService 为标准模式，无需声明。

不要假设您的 TileService 将存在于 onStartListening() 和 onStopListening() 方法对之外。

活动模式（推荐）

对于在自己的进程中监听并监控其状态的 TileService，请使用活动模式。处于活动模式的 TileService 会绑定到 onTileAdded()、onTileRemoved()、点击事件以及应用进程请求时。

如果您的 TileService 在其自身进程应该更新其磁贴状态时收到通知，我们建议使用活动模式。活动磁贴限制了对系统的压力，因为它们不必每次快速设置面板对用户可见时都进行绑定。

可以使用静态方法 TileService.requestListeningState() 请求监听状态的开始，并接收对 onStartListening() 的回调。

您可以通过将 META_DATA_ACTIVE_TILE 添加到您的应用清单文件中来声明活动模式。

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

非活动模式

非活动模式是标准模式。如果只要您的磁贴对用户可见就绑定 TileService，则该服务处于非活动模式。这意味着您的 TileService 可能会在超出其控制的时间内被创建和重新绑定。当用户没有查看磁贴时，它也可能被解绑和销毁。

用户打开他们的快速设置面板后，您的应用会收到对 onStartListening() 的回调。您可以在 onStartListening() 和 onStopListening() 之间根据需要多次更新您的 Tile 对象。

您不需要声明非活动模式——只需不要将 META_DATA_ACTIVE_TILE 添加到您的应用清单文件即可。

磁贴状态概述

用户添加您的磁贴后，它始终存在于以下状态之一。

• STATE_ACTIVE：表示开启或启用状态。用户在此状态下可以与您的磁贴交互。

  例如，对于允许用户启动计时训练课程的健身应用磁贴，STATE_ACTIVE 表示用户已启动训练课程并且计时器正在运行。

• STATE_INACTIVE：表示关闭或暂停状态。用户在此状态下可以与您的磁贴交互。

  再次使用健身应用磁贴示例，处于 STATE_INACTIVE 状态的磁贴表示用户尚未启动训练课程，但如果他们愿意，可以这样做。

• STATE_UNAVAILABLE：表示暂时不可用状态。用户在此状态下无法与您的磁贴交互。

  例如，处于 STATE_UNAVAILABLE 状态的磁贴意味着由于某种原因，磁贴目前对用户不可用。

系统仅设置 Tile 对象的初始状态。您在 Tile 对象的整个生命周期中设置其状态。

系统可能会对磁贴图标和背景进行着色以反映 Tile 对象的状态。Tile 对象设置为 STATE_ACTIVE 的颜色最深，STATE_INACTIVE 和 STATE_UNAVAILABLE 的颜色越来越浅。确切的色调取决于制造商和版本。

更新您的磁贴

收到对 onStartListening() 的回调后，您可以更新您的磁贴。根据磁贴的模式，您的磁贴至少可以更新一次，直到收到对 onStopListening() 的回调。

在活动模式下，您可以在收到对 onStopListening() 的回调之前只更新您的磁贴一次。在非活动模式下，您可以在 onStartListening() 和 onStopListening() 之间根据需要多次更新您的磁贴。

您可以通过调用 getQsTile() 来检索您的 Tile 对象。要更新 Tile 对象的特定字段，请调用以下方法：

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

完成将 Tile 对象的字段设置为正确的值后，必须调用 updateTile() 来更新您的磁贴。这将使系统解析更新后的磁贴数据并更新 UI。

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

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

处理点击

如果您的磁贴处于 STATE_ACTIVE 或 STATE_INACTIVE 状态，用户可以点击您的磁贴来触发操作。然后，系统将调用您的应用的 onClick() 回调。

您的应用收到对 onClick() 的回调后，可以启动对话框或活动、触发后台工作或更改磁贴的状态。

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

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

启动对话框

showDialog() 会折叠快速设置面板并显示一个对话框。如果操作需要其他输入或用户同意，请使用对话框为操作添加上下文。

启动活动

startActivityAndCollapse() 在折叠面板的同时启动活动。如果要显示比对话框中更多详细信息，或者如果您的操作是高度交互式的，则活动非常有用。

如果您的应用需要大量的用户交互，则应用应仅作为最后手段启动活动。相反，请考虑使用对话框或切换。

长按磁贴会提示用户的应用信息屏幕。要覆盖此行为并改为启动设置首选项的活动，请向您的一个活动添加 <intent-filter>，其中包含 ACTION_QS_TILE_PREFERENCES。

从 Android API 28 开始，PendingIntent 必须具有 Intent.FLAG_ACTIVITY_NEW_TASK

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

您也可以在特定 Activity 部分的 AndroidManifest.xml 中添加此标志。

将您的磁贴标记为可切换

如果您的磁贴主要用作双状态开关（这是磁贴最常见的行为），我们建议将其标记为可切换。这有助于向操作系统提供有关磁贴行为的信息，并提高整体可访问性。

将 TOGGLEABLE_TILE 元数据设置为 true 以将您的磁贴标记为可切换。

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

仅在安全锁定的设备上执行安全操作

您的磁贴可能会显示在锁定设备的锁屏顶部。如果磁贴包含敏感信息，请检查 isSecure() 的值以确定设备是否处于安全状态，并且您的 TileService 应相应地更改其行为。

如果磁贴操作在锁定状态下是安全的，请使用 startActivity() 在锁屏顶部启动活动。

如果磁贴操作不安全，请使用 unlockAndRun() 提示用户解锁设备。如果成功，系统将执行您传递给此方法的 Runnable 对象。

提示用户添加您的磁贴

要手动添加您的磁贴，用户必须执行以下几个步骤：

1. 向下滑动以打开快速设置面板。
2. 点击编辑按钮。
3. 滚动浏览设备上的所有磁贴，直到找到您的磁贴。
4. 按住您的磁贴，并将其拖动到活动磁贴列表中。

用户也可以随时移动或移除您的磁贴。

从 Android 13 开始，您可以使用 requestAddTileService() 方法，使用户更容易将您的磁贴添加到设备中。此方法会提示用户直接将您的磁贴快速添加到他们的快速设置面板中。提示包括应用程序名称、提供的标签和图标。

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

回调包含有关磁贴是否已添加、未添加、是否已存在或是否发生任何错误的信息。

在决定何时以及多久提示用户一次时，请谨慎行事。我们建议仅在上下文中调用 requestAddTileService()，例如当用户第一次与您的磁贴所促进的功能交互时。

如果某个ComponentName之前已被用户拒绝多次，系统可以选择停止处理针对它的请求。用户由用于检索此服务的Context确定——它必须与当前用户匹配。