このページは Cloud Translation API によって翻訳されました。

アプリ用のカスタムクイック設定タイルを作成する

クイック設定は、クイック設定パネルに表示されるタイルで、ユーザーがタップして、繰り返すタスクをすばやく完了できるようにします。アプリでは、TileService を使用してユーザーにカスタムタイルを提供できます。クラスと、Tile オブジェクトを使用してタイルの状態を追跡します。たとえばアプリが提供する VPN をユーザーが有効にしたり、オフにします。

VPN タイルが表示されたクイック設定パネル
オンとオフ — **図 1.** VPN タイルが表示されたクイック設定パネル

タイルを作成するタイミングを決定する

ユーザーが期待する特定の機能のタイルを作成することをおすすめします頻繁にアクセスするか、すばやくアクセスする必要があるか、またはその両方です。最も効果的なのはこれらの両方の特性にマッチするタイルを使用すると、おすすめします

たとえば、フィットネスアプリのタイルを作成して、ユーザーがワークアウトセッションを簡単に開始できますただし、タイルを作成し、ユーザーがワークアウトの全履歴を確認できるようにしました。

フィットネスアプリタイルのユースケース — **図 2.** フィットネスアプリのタイルの推奨例と推奨されない例

タイルの見つけやすさと使いやすさを改善するには、避けることをおすすめします。

アプリを起動するためにタイルを使用することは避けてください。アプリのショートカットまたは標準のショートカットを使用するランチャーを使用してください。
1 回限りのユーザー操作にタイルを使用しないでください。アプリのショートカットまたは通知を使用してください。
タイルを多用しすぎないようにしましょう。1 つのアプリにつき 2 つまでをおすすめします。以下を使用します: アプリのショートカットを使用してください。
情報を表示するタイルは使用せず、インタラクティブではないできます。代わりに通知またはウィジェットを使用してください。

タイルを作成する

タイルを作成するには、まず適切なタイルアイコンを作成してから、アプリのマニフェストファイルで TileService を作成して宣言します。

クイック設定のサンプルでは、設定方法の一例を紹介しています。タイルを管理できます。

カスタムアイコンを作成する

クイックアイコンのタイルに表示されるカスタムアイコンを用意する必要があります。設定パネル。（このアイコンは、TileService を宣言するときに追加します。（次のセクションで説明します）。アイコンは白色で点灯し、透明な背景、24 x 24 dp、 VectorDrawable。

タイルの目的を視覚的に示唆するアイコンを作成します。これにより、タイルがニーズに合っているかどうかを簡単に確認できます。たとえば、サーバーモジュールを作成し、ユーザーが開始できるフィットネスアプリのタイルのストップウォッチのアイコン記録します。

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 がバインドされるタイミングアプリがアプリによってリクエストされているかどうか、またはシステムがそれと通信する必要がある場合。典型的な bound-serviceLifecycle には、次の 4 つのコールバックメソッドが含まれています。 onCreate()、onBind()、onUnbind()、 onDestroy()これらのメソッドは、ライフサイクルフェーズに入ります。

TileService のライフサイクルの概要

バインドされたサービスのライフサイクルを制御するコールバックに加えて、 TileService ライフサイクルに固有の他のメソッドを実装します。これらのメソッドは、 onCreate() と onDestroy() の外部で呼び出される場合があります。これは、Service がライフサイクルメソッドと TileService ライフサイクルメソッドは、2 つの非同期スレッドを分離できます

TileService ライフサイクルには、呼び出される次のメソッドが含まれます。 TileService が新しいライフサイクルフェーズに入るたびに、システムにより次のように処理されます。

onTileAdded(): このメソッドは、ユーザーがユーザーがタイルを削除して再度追加した場合などです。これが 1 回限りの初期化を行うのに最適なタイミングです。ただし、初期化の条件をすべて満たしているとは言えません。

注: onTileAdded() は、タイルが作成されるたびに呼び出されることはありません。対象たとえば、デバイスを再起動したとき、または再起動したときに onTileAdded() が呼び出されないタイルが追加されていて、デバイスの追加前に削除されなかった場合は、電源がオンになります電源がオフになっています。
onStartListening() と onStopListening(): これらのメソッドは、アプリがタイルを更新するたびに呼び出され、頻繁に呼び出されます。「 TileService は onStartListening() と onStopListening(): アプリがタイルを変更して更新をプッシュできるようにします。
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() へのコールバックを受け取ります。クイック設定パネル。Tile オブジェクトは何回でも更新できます。 onStartListening()～onStopListening() の範囲で入力してください。

非アクティブモードを宣言する必要はなく、単に 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 が徐々に明るくなります。正確な色相メーカーとバージョンに固有です

オブジェクトの状態を反映して色合いを調整した VPN タイル — **図 4.** タイルの状態（それぞれアクティブ、非アクティブ、利用不可の状態）を反映するために色合いを調整したタイルの例。

タイルを更新する

onStartListening() へのコールバックを受け取ったら、タイルを更新できます。タイルのモードに応じて、次の期限まで少なくとも 1 回はタイルを更新できます。 onStopListening() へのコールバックを受信したとき。

アクティブモードでは、タイルを 1 回だけ更新してから、 onStopListening() へのコールバック。非アクティブモードでは、タイルを次のように更新できます。 onStartListening()～onStopListening() の間で何度でも指定できます。

Tile オブジェクトを取得するには、getQsTile() を呼び出します。更新方法 Tile オブジェクトの特定のフィールドに追加する場合は、次のメソッドを呼び出します。

で確認できます。

タイルの設定が完了したら、updateTile() を呼び出してタイルを更新する必要があります。 Tile オブジェクトのフィールドに正しい値を設定します。これにより、更新されたタイルデータを解析し、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();
}

タップを処理する

タイルがタイルに含まれる場合、ユーザーはタイルをタップしてアクションをトリガーできる STATE_ACTIVE または STATE_INACTIVE。その後、システムはアプリの onClick() コールバック。

アプリは、onClick() へのコールバックを受け取ると、ダイアログを起動するか、バックグラウンド処理をトリガーしたり、タイルの状態を変更したりできます。

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() をクリックすると、クイック設定パネルが折りたたまれ、ダイアログが表示されます。追加の入力が必要な場合は、ダイアログを使用してアクションにコンテキストを追加します。許可または拒否されます。

アクティビティを開始する

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

また、特定の Terraform 構成ファイルの AndroidManifest.xml にフラグを追加することもできます。 Activity セクション。

タイルを切り替え可能としてマークする

タイルが主に次の機能として機能する場合は、切り替え可能としてマークすることをおすすめしますタイルの最も一般的な動作です。これにより、タイルの動作に関する情報をオペレーティングシステムに提供し、全体的なアクセシビリティが向上します。

タイルを切り替え可能としてマークするには、TOGGLEABLE_TILE メタデータを true に設定します。

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

安全にロックされたデバイスで安全な操作のみを実行します

ロックされたデバイスでは、ロック画面の上部にタイルが表示されることがあります。もしタイルがに機密情報が含まれている場合は、isSecure() の値を確認して、デバイスが安全な状態かどうかを判別し、TileService がそれに応じて動作を変更します。

ロック中にタイルアクションを安全に実行できる場合は、startActivity() を使用します。ロック画面でアクティビティを起動できます。

タイルアクションが安全でない場合は、unlockAndRun() を使用してユーザーにプロンプトを表示します。ロックを解除できます。成功すると、システムによってこれに渡す Runnable オブジェクトメソッドを呼び出します。

タイルを追加するようユーザーに促す

タイルを手動で追加するには、ユーザーが以下の操作を行う必要があります。

下にスワイプしてクイック設定パネルを開きます。
編集ボタンをタップします。
目的のタイルが見つかるまで、デバイスのすべてのタイルをスクロールします。
タイルを長押しして、アクティブなタイルのリストにドラッグします。

また、ユーザーはいつでもタイルを移動、削除できます。

Android 13 以降では、requestAddTileService() メソッドを使用できます。ユーザーが簡単にタイルをデバイスに追加できるようになります。この方法はタイルをクイックビューに直接追加するよう、ユーザーに求めるメッセージが表示されます設定パネル。プロンプトには、アプリケーション名、指定されたラベル、追加できます

クイック設定 Placement API プロンプト — **図 5.**Quick Settings Placement API プロンプト。

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

このコールバックには、タイルが追加されたかどうかの情報が含まれます。タイルは存在する場合や、エラーが発生した場合は、追加されたかどうかが判断されます。

プロンプトを表示するタイミングと頻度は、ご自身の裁量で決定してください。水 requestAddTileService() は、次のような状況でのみ呼び出すことをおすすめします。タイルで実現されている機能をユーザーが初めて操作したとき。

システムは、特定のサービスに対するリクエストの処理を ComponentName: ユーザーが以前に十分な回数リクエストを拒否した場合。「ユーザーがこれを取得するために使用される Context から判断されます。現在のユーザーと一致する必要があります。

アプリ用のカスタム クイック設定タイルを作成する

タイルを作成するタイミングを決定する

タイルを作成する

カスタム アイコンを作成する

TileService を作成して宣言する

Kotlin

Java

TileService を管理する

TileService のライフサイクルの概要

リスニング モードを選択する

アクティブ モード（推奨）

非アクティブ モード

タイルの状態の概要

タイルを更新する

Kotlin

Java

タップを処理する

Kotlin

Java

ダイアログを起動する

アクティビティを開始する

タイルを切り替え可能としてマークする

安全にロックされたデバイスで安全な操作のみを実行します

タイルを追加するようユーザーに促す

アプリ用のカスタムクイック設定タイルを作成する

カスタムアイコンを作成する

リスニングモードを選択する

アクティブモード（推奨）

非アクティブモード