为您的应用创建自定义“快捷设置”图块

“快捷设置”是显示在“快捷设置”面板中的功能块，表示用户可点按它们以快速完成周期性任务。您的应用可以通过 TileService 类向用户提供自定义功能块，并使用 Tile 对象跟踪功能块的状态。例如，您可以创建一个功能块，让用户开启或关闭您的应用提供的 VPN。

图 1. 开启和关闭 VPN 功能块的“快捷设置”面板。

注意： 本指南仅讨论非 Wear 功能块 -“快捷设置”功能块与 Wear OS 中定义的功能块无关。如需了解 Wear OS 功能块，请参阅 WearOS 功能块指南。

确定何时创建功能块

我们建议您针对您希望用户经常访问和/或需要快速使用的特定功能创建功能块。最有效的功能块同时具备这两种特性，可让用户快速执行常用操作。

例如，您可以为健身应用创建功能块，以便用户快速开始锻炼。但是，我们不建议为同一应用创建可让用户查看其整个锻炼历史记录的功能块。

图 2. 健身应用的推荐功能块与不推荐的功能块示例。

为了提高功能块的可发现性和易用性，我们建议您避免以下做法：

• 避免使用功能块启动应用。请改用应用快捷方式或标准启动器。

• 避免使用功能块来执行一次性用户操作。请改用应用快捷方式或通知。

• 避免创建过多功能块。我们建议每个应用最多设置两个。请改用应用快捷方式。

• 避免使用仅显示信息但不与用户互动的功能块。请改用通知或 widget。

创建功能块

如需创建功能块，您需要先创建合适的功能块图标，然后在应用的清单文件中创建并声明 TileService。

注意 ：为应用创建 TileService 并不会将其添加到用户的“快捷设置”面板中。只有在用户添加功能块后，您的 TileService 才会充当与功能块的接口。

“快捷设置”示例提供了有关如何创建和管理功能块的示例。

创建自定义图标

您需要提供一个自定义图标，该图标将显示在“快捷设置”面板中的功能块中。（您将在声明 TileService 时添加此图标，如下一部分所述。）该图标必须为纯白色、透明背景，尺寸为 24 x 24dp，并且采用 VectorDrawable 形式。

图 3. 矢量可绘制对象示例。

创建一个图标，以直观的方式提示功能块的用途。这有助于用户轻松确定您的功能块是否符合其需求。例如，您可以为健身应用的功能块创建秒表图标，以允许用户开始锻炼时段。

创建并声明 TileService

为功能块创建一个扩展 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();
  }
}

在应用的清单文件中声明 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 通信时，系统会绑定 TileService。典型的绑定服务生命周期包含以下四个回调方法：onCreate()、onBind()、onUnbind() 和 onDestroy()。每当服务进入新的生命周期阶段时，系统都会调用这些方法。

重要提示： 您的 TileService 仍会经历典型的 Service 生命周期。不过，TileService 与大多数其他绑定服务不同，因为它包含应用必须响应的 TileService 专用生命周期方法。

TileService 生命周期概览

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

TileService 生命周期包含以下方法，系统会在 TileService 每次进入新的生命周期阶段时调用这些方法：

• onTileAdded()：仅当用户首次添加功能块，并且用户移除并重新添加功能块时，系统才会调用此方法。这是执行任何一次性初始化的最佳时间。不过，这可能无法满足所有所需的初始化。

  注意： 并非每次创建功能块时都会调用 onTileAdded()。例如，如果在设备关闭之前已添加功能块且未将其移除，则在设备重新启动或开机时不会调用 onTileAdded()。

• onStartListening() 和 onStopListening()：每当您的应用更新功能块时，系统都会调用这两个方法，并且调用频率很高。TileService 在 onStartListening() 和 onStopListening() 之间保持绑定状态，允许您的应用修改功能块并推送更新。

• onTileRemoved()：仅当用户移除功能块时，系统才会调用此方法。

注意： 这些阶段可能不会连续发生。当用户将您的功能块添加到其“快捷设置”面板时，只能调用一次 onTileAdded()。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 对象。

注意： 如果您使用非活动模式（而非活动模式），您的 TileService 可能会在用户每次打开“快捷设置”面板时绑定。

您无需声明非活跃模式，只需不向应用的清单文件添加 META_DATA_ACTIVE_TILE 即可。

图块状态概览

用户添加功能块后，该功能块始终会处于以下某种状态。

• STATE_ACTIVE：表示开启或启用状态。在此状态下，用户可以与您的功能块互动。

  例如，对于允许用户发起定时锻炼时段的健身应用功能块，STATE_ACTIVE 表示用户已发起锻炼时段，并且计时器正在运行。

• STATE_INACTIVE：表示关闭或暂停状态。在这种状态下，用户可以与功能块互动。

  再次使用健身应用功能块示例，STATE_INACTIVE 中的功能块表示用户尚未发起锻炼时段，但可以根据需要发起锻炼时段。

• STATE_UNAVAILABLE：表示暂时不可用的状态。用户在此状态下无法与您的功能块互动。

  例如，STATE_UNAVAILABLE 中的功能块表示由于某种原因，用户当前无法使用该功能。

  注意： 对于目前不可用但日后可能会变为可用状态的功能块，请使用 STATE_UNAVAILABLE。如果组件永远不会再次向用户提供，请将 COMPONENT_ENABLED_STATE_DISABLED 传入 setComponentEnabledSetting()。

系统仅设置 Tile 对象的初始状态。您可以在 Tile 对象的整个生命周期剩余时间内设置其状态。

系统可能会调整功能块图标和背景的色调，以反映 Tile 对象的状态。设置为 STATE_ACTIVE 的 Tile 对象最暗，STATE_INACTIVE 和 STATE_UNAVAILABLE 的颜色逐渐变浅。确切的色调因制造商和版本而异。

图 4. 通过着色来反映功能块状态（分别为活跃、非活跃和不可用状态）的功能块示例。

更新功能块

收到 onStartListening() 回调后，您可以更新功能块。在收到对 onStopListening() 的回调之前，功能块至少可以更新一次，具体取决于功能块的模式。

在活动模式下，您可以在接收对 onStopListening() 的回调之前，仅更新一次功能块。在非活动模式下，您可以在 onStartListening() 到 onStopListening() 之间根据需要多次更新功能块。

注意： 在“活跃”模式下，无论功能块对用户是否可见，您都可以更新功能块。

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

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

注意： 在应用的清单文件中设置的图标和标签是“快捷设置”面板中功能块上显示的默认值。不过，您可以在更新功能块时调用 setIcon() 和 setLabel() 方法，将字段设置为新值。

将 Tile 对象的字段设置为正确值后，您必须调用 updateTile() 来更新功能块。这将使系统解析更新后的功能块数据并更新界面。

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

处理点按

如果您的功能块位于 STATE_ACTIVE 或 STATE_INACTIVE 中，则用户可以点按功能块以触发操作。然后，系统会调用应用的 onClick() 回调。

应用收到 onClick() 的回调后，便可以启动对话框或 activity、触发后台工作或更改功能块的状态。

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

启动对话框

showDialog() 可收起“快捷设置”面板并显示一个对话框。 如果对话框需要额外输入或征得用户同意，可以使用对话框为操作添加上下文。

注意 ：isLocked() 会检查用户的锁定屏幕是否显示。当 isLocked() 返回 true 时，showDialog() 不会显示可见对话框，因为它会在锁屏下加载。

启动 activity

startActivityAndCollapse() 会在收起面板的同时启动 activity。如果需要比在对话框中显示的详细信息，或者您的操作具有高度互动性，activity 会非常有用。

如果您的应用需要大量用户互动，则应仅在万不得已时启动 activity。请改为考虑使用对话框或切换开关。

长按某个功能块会向用户显示应用信息界面。如需替换此行为，改为启动用于设置偏好的 activity，请使用 ACTION_QS_TILE_PREFERENCES 向其中一个 activity 添加 <intent-filter>。

从 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() 在锁定的屏幕上启动 activity。

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

提示用户添加功能块

如需手动添加功能块，用户必须按照以下步骤操作：

1. 向下滑动以打开“快捷设置”面板。
2. 点按“修改”按钮。
3. 滚动浏览其设备上的所有功能块，直到找到您的功能块。
4. 按住功能块，将其拖动到有效功能块列表中。

用户还可以随时移动或移除您的功能块。

从 Android 13 开始，您可以使用 requestAddTileService() 方法，让用户更轻松地将功能块添加到设备。此方法会提示用户直接将您的功能块快速添加到其“快捷设置”面板。提示包含应用名称、提供的标签和图标。

图 5. Quick Settings Placement API 提示。

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

该回调包含有关是否添加了功能块、未添加、是否已存在或是否发生了任何错误的信息。

在决定向用户显示提示的时间和频率时，请自行判断。我们建议仅在上下文中调用 requestAddTileService()，例如当用户首次与功能块提供的功能互动时。

如果用户之前已多次拒绝对给定 ComponentName 的请求，系统可能会选择停止处理此类请求。用户是根据用于检索此服务的 Context 确定的，该 Context 必须与当前用户匹配。

注意： 我们建议调用 requestAddTileService() 以提高功能块的可检测性，并减轻用户将功能块添加到“快捷设置”面板的负担。