ロックタスク モード

このデベロッパー ガイドでは、専用デバイスを 1 つのアプリまたはアプリセットにロックする方法について説明します。企業向けモバイル管理（EMM）のデベロッパーやソリューション インテグレータの方は、このガイドをお読みになり、ソリューションにロックタスク モードを追加してください。

概要

Android では、ロックタスク モードというキオスクモードのような没入型の方法でタスクを実行できます。ロックタスク モードは、アプリのコレクションを表示するためのキオスクアプリやランチャーを開発している場合に使用できます。システムがロックタスク モードで実行されている場合、デバイス ユーザーは通常、通知を表示すること、許可リストに登録されていないアプリにアクセスすること、ホーム画面に戻ることはできません（ホーム画面が許可リストに登録されている場合を除きます）。

システムがロックタスク モードになっているときは、Device Policy Controller（DPC）によって許可リストに登録されたアプリのみを実行できます。デバイスを使用するユーザーが常にロックタスク モードを終了できるわけではないため、アプリは許可リストに登録されています。

ロックタスク モードの許可リストに登録されたアプリと許可リスト DPC を組み合わせる方法は、解決したい問題によって異なります。以下の例をご参照ください。

• キオスク（コンテンツの表示用）と mini DPC（ロックタスク モードの許可リストへの登録）を組み合わせた単一のアプリ パッケージ。
• 企業向けモバイル管理ソリューションの一部である DPC。お客様のモバイルアプリをロックタスク モードで起動します。

提供状況

Android 5.0 以降では、システムはロックタスク モードで実行できます。表 1 に、ユーザー別のアプリの許可リスト登録をサポートする Android のバージョンを示します。

Android 9.0 以降では、DPC はアプリのアクティビティをロックタスク モードで開始できます。以前のバージョンでは、アプリはロックタスク モードで独自のアクティビティを開始することをすでにサポートしている必要があります。

アプリを許可リストに登録

DPC は、ロックタスク モードで使用する前にアプリを許可リストに登録する必要があります。次のサンプルに示すように、DevicePolicyManager.setLockTaskPackages() を呼び出してアプリをロックタスク モードの許可リストに登録します。

// Allowlist two apps.
private val KIOSK_PACKAGE = "com.example.kiosk"
private val PLAYER_PACKAGE = "com.example.player"
private val APP_PACKAGES = arrayOf(KIOSK_PACKAGE, PLAYER_PACKAGE)

// ...

val context = context
val dpm = context.getSystemService(Context.DEVICE_POLICY_SERVICE)
        as DevicePolicyManager
val adminName = getComponentName(context)
dpm.setLockTaskPackages(adminName, APP_PACKAGES)

// Allowlist two apps.
private static final String KIOSK_PACKAGE = "com.example.kiosk";
private static final String PLAYER_PACKAGE = "com.example.player";
private static final String[] APP_PACKAGES = {KIOSK_PACKAGE, PLAYER_PACKAGE};

// ...

Context context = getContext();
DevicePolicyManager dpm =
    (DevicePolicyManager) context.getSystemService(Context.DEVICE_POLICY_SERVICE);
ComponentName adminName = getComponentName(context);
dpm.setLockTaskPackages(adminName, APP_PACKAGES);

以前にロックタスク モードの許可リストに登録されたアプリを確認するには、DPC で DevicePolicyManager.getLockTaskPackages() を呼び出します。他のアプリは DevicePolicyManager.isLockTaskPermitted() を呼び出して、アプリ パッケージがロックタスク モードをサポートしているかどうかを確認できます。

ロックタスク モードを開始する

Android 9.0（API レベル 28）以降では、別のアプリのアクティビティをロックタスク モードで起動できます。アクティビティがすでにフォアグラウンドまたはバックグラウンドで実行されている場合は、そのアクティビティを再起動する必要があります。ActivityOptions.setLockTaskEnabled() を呼び出し、アクティビティの起動時にこれらのオプションを指定します。次のスニペットは、これを行う方法の一例です。

// Set an option to turn on lock task mode when starting the activity.
val options = ActivityOptions.makeBasic()
options.setLockTaskEnabled(true)

// Start our kiosk app's main activity with our lock task mode option.
val packageManager = context.packageManager
val launchIntent = packageManager.getLaunchIntentForPackage(KIOSK_PACKAGE)
if (launchIntent != null) {
    context.startActivity(launchIntent, options.toBundle())
}

// Set an option to turn on lock task mode when starting the activity.
ActivityOptions options = ActivityOptions.makeBasic();
options.setLockTaskEnabled(true);

// Start our kiosk app's main activity with our lock task mode option.
PackageManager packageManager = context.getPackageManager();
Intent launchIntent = packageManager.getLaunchIntentForPackage(KIOSK_PACKAGE);
if (launchIntent != null) {
  context.startActivity(launchIntent, options.toBundle());
}

バージョン 9.0 より前の Android では、アプリは Activity.startLockTask() を呼び出すことで、ロックタスク モードで独自のアクティビティを開始します。このメソッドを呼び出すには、アクティビティがフォアグラウンドで実行されている必要があります（アクティビティのライフサイクルのコンセプトをご覧ください）。このため、Activity または Fragment の onResume() メソッドを呼び出すことをおすすめします。startLockTask() を呼び出す方法は次のとおりです。

// In our Fragment subclass.
override fun onResume() {
    super.onResume()
    // First, confirm that this package is allowlisted to run in lock task mode.
    if (dpm.isLockTaskPermitted(context.packageName)) {
        activity.startLockTask()
    } else {
        // Because the package isn't allowlisted, calling startLockTask() here
        // would put the activity into screen pinning mode.
    }
}

// In our Fragment subclass.
@Override
public void onResume() {
  super.onResume();

  // First, confirm that this package is allowlisted to run in lock task mode.
  if (dpm.isLockTaskPermitted(context.getPackageName())) {
    getActivity().startLockTask();
  } else {
    // Because the package isn't allowlisted, calling startLockTask() here
    // would put the activity into screen pinning mode.
  }
}

ユーザーがデバイスのロックを解除できない可能性があるため、デバイスがロックされているときにロックタスク モードを開始しないでください。KeyguardManager メソッドを呼び出してデバイスがロックされているかどうかを確認し、Activity ライフサイクル コールバック（ロック解除後に呼び出される onResume() など）を使用してロックタスク モードを開始できます。

ロックタスク モードのアプリは、アクティビティが新しいタスクを開始しない限り、新しいアクティビティを開始できます（許可リストに登録されたアプリを起動するタスクを除く）。タスクとアクティビティの関係については、タスクとバックスタックについてのガイドをご覧ください。

または、システムがロックタスク モードで実行されているときのアクティビティの動作をアプリ マニフェスト ファイルで宣言することもできます。アクティビティをロックタスク モードで自動的に実行するには、次の例に示すように、android:lockTaskMode 属性を if_whitelisted に設定します。

<activity
    android:name=".MainActivity"
    android:lockTaskMode="if_whitelisted">
    <!-- ... -->
</activity>

アプリ マニフェスト ファイルでのオプション宣言について詳しくは、lockTaskMode リファレンスをご覧ください。

ロックタスク モードを停止

DPC は、許可リストからアプリ パッケージを削除することで、ロックタスク モードをリモートで停止できます。Android 6.0（API レベル 23）以降では、DevicePolicyManager.setLockTaskPackages() を呼び出し、許可リストの配列からパッケージ名を省略します。許可リストを更新すると、アプリはスタック内の前のタスクに戻ります。

アクティビティが以前に startLockTask() を呼び出していた場合、アクティビティは Activity.stopLockTask() を呼び出してロックタスク モードを停止できます。このメソッドは、ロックタスク モードを開始したアクティビティに対してのみ機能します。

ライフサイクル コールバック

DPC は、（同じユーザーで実行されている）アプリがいつロックタスク モードを開始したり終了したりするタイミングを把握できると便利です。コールバックを受信するには、DPC の DeviceAdminReceiver サブクラスで次のコールバック メソッドをオーバーライドします。

onLockTaskModeEntering()

アプリがロックタスク モードになった後に呼び出されます。アプリのパッケージ名は pkg 引数から取得できます。

onLockTaskModeExiting()

アプリがロックタスク モードを終了した後に呼び出されます。このコールバックは、アプリに関する情報は受け取りません。

別のアプリをロックタスク モードで起動する場合は、独自のアプリで実行ステータスを追跡する必要があります。現在のアプリがロックタスク モードで実行されているかどうかを確認するには、次の例に示すように ActivityManager のメソッドを使用します。

// Check if this app is in lock task mode. Screen pinning doesn't count.
var isLockTaskModeRunning = false

val activityManager = context
        .getSystemService(Context.ACTIVITY_SERVICE) as ActivityManager

if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
    isLockTaskModeRunning =
            activityManager.lockTaskModeState ==
            ActivityManager.LOCK_TASK_MODE_LOCKED
} else if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
    // Deprecated in API level 23.
    isLockTaskModeRunning = activityManager.isInLockTaskMode
}

if (isLockTaskModeRunning) {
    // Show the exit button ...
}

// Check if this app is in lock task mode. Screen pinning doesn't count.
boolean isLockTaskModeRunning = false;

ActivityManager activityManager = (ActivityManager)
    getContext().getSystemService(Context.ACTIVITY_SERVICE);

if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
  isLockTaskModeRunning = activityManager.getLockTaskModeState()
      == ActivityManager.LOCK_TASK_MODE_LOCKED;
} else if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
  // Deprecated in API level 23.
  isLockTaskModeRunning = activityManager.isInLockTaskMode();
}

if (isLockTaskModeRunning) {
  // Show the exit button ...
}

UI をカスタマイズする

アプリがロックタスク モードで実行されると、システム ユーザー インターフェース（UI）が次のように変化します。

• ステータスバーは空白で、通知とシステム情報が非表示になります。
• [ホーム] ボタンと [最近] ボタンは表示されません。
• 他のアプリは新しいアクティビティを起動できません。
• ロック画面（設定されている場合）は無効になります。

Android 9.0 以降では、ロックタスク モードが有効になっている場合、DPC がデバイスの特定のシステム UI 機能を有効にすることができます。これはデベロッパーがカスタム ランチャーを作成する場合に便利です。次のスニペットに示すように、DevicePolicyManager.setLockTaskFeatures() を呼び出します。

// Enable the Home and Overview buttons so that our custom launcher can respond
// using our custom activities. Implicitly disables all other features.
dpm.setLockTaskFeatures(
        adminName,
        DevicePolicyManager.LOCK_TASK_FEATURE_HOME or
              DevicePolicyManager.LOCK_TASK_FEATURE_OVERVIEW)

// Enable the Home and Overview buttons so that our custom launcher can respond
// using our custom activities. Implicitly disables all other features.
dpm.setLockTaskFeatures(adminName,
    DevicePolicyManager.LOCK_TASK_FEATURE_HOME |
          DevicePolicyManager.LOCK_TASK_FEATURE_OVERVIEW);

flags 引数に含めない機能はすべて無効になります。有効な UI 機能は、ロックタスク モードで起動する間も維持されます。デバイスがすでにロックタスク モードになっている場合、ロックタスク機能に加えた変更はすぐに表示されます。表 2 に、カスタマイズできる UI 機能を示します。

DPC は、ロックタスク モードが有効な場合にデバイスで使用できる機能のリストを取得するために DevicePolicyManager.getLockTaskFeatures() を呼び出すことができます。デバイスがロックタスク モードを終了すると、ユーザー インターフェースは既存のデバイス ポリシーで義務付けられた状態に戻ります。

ウィンドウとオーバーレイをブロックする

アプリがロックタスク モードで実行されると、他のアプリやバックグラウンド サービスは、Android がロックタスク モードでアプリの前面に表示する新しいウィンドウを作成できます。アプリとサービスによってこれらのウィンドウが作成され、デバイスを使用しているユーザーにトースト、ダイアログ、オーバーレイが表示されます。DPC は、DISALLOW_CREATE_WINDOWS ユーザー制限を追加することでこれを防止できます。次の例は、onLockTaskModeEntering() コールバックでこれを行う方法を示しています。

// Called just after entering lock task mode.
override fun onLockTaskModeEntering(context: Context, intent: Intent) {
    val dpm = getManager(context)
    val admin = getWho(context)

    dpm.addUserRestriction(admin, UserManager.DISALLOW_CREATE_WINDOWS)
}

// Called just after entering lock task mode.
public void onLockTaskModeEntering(Context context, Intent intent) {
  DevicePolicyManager dpm = getManager(context);
  ComponentName admin = getWho(context);

  dpm.addUserRestriction(admin, UserManager.DISALLOW_CREATE_WINDOWS);
}

DPC は、デバイスがロックタスク モードを終了したときにユーザー制限を解除できます。

参考情報

専用デバイスについて詳しくは、以下のドキュメントをご覧ください。

• 専用デバイス クックブック。専用デバイスを制限し、ユーザー エクスペリエンスを向上させるためのその他の例が記載されています。
• 専用デバイスの概要では、専用デバイスの概要について説明します。
• 複数のユーザーを管理するでは、ユーザー間でデバイスを共有する方法について説明します。