バブルを使用してユーザーが会話に参加できるようにする

バブルを使用すると、会話の内容を簡単に把握したり、会話に参加したりできます。

図 1. チャットのふきだし。

バブルは通知システムに組み込まれています。他のアプリ コンテンツの上にフローティング表示され、ユーザーが画面表示を切り替えても一緒に移動します。バブルを展開すると、そのアプリのコンテンツを表示して操作できます。バブルが不要になったら、折りたたむことが可能です。

デバイスがロックされているときや、アンビエント表示（常時表示ディスプレイ）がアクティブになっているとき、バブルは通常の通知と同じように表示されます。

バブルは、オプトアウト式の機能です。アプリが初めてバブルを表示する際、ユーザーに権限ダイアログが表示され、次の 2 つの選択肢が提示されます。

• このアプリが表示するバブルをすべてブロック - 通知はブロックされませんが、バブルとして表示されることはありません。
• アプリからのすべてのバブルを許可します。BubbleMetaData を指定して送信されたすべての通知がバブルとして表示されます。

Bubble API

バブルは notification API を使用して作成されるため、通常どおり通知を送信します。通知をバブルとして表示するには、追加データを付加します。

バブルの展開ビューは、デベロッパーが選択したアクティビティから作成されます。バブルとして正しく表示されるようにアクティビティを設定します。アクティビティの要件として、サイズ変更が可能であること、埋め込み型であることが求められます。この要件を 1 つでも満たさなかった場合は、バブルではなく、通知として表示されます。

バブルを実装する方法は次のコードに示します。

<activity
  android:name=".bubbles.BubbleActivity"
  android:theme="@style/AppTheme.NoActionBar"
  android:label="@string/title_activity_bubble"
  android:allowEmbedded="true"
  android:resizeableActivity="true"
/>

アプリが同じタイプのバブルを複数表示する場合（たとえば、異なる連絡先とのチャット スレッドを複数表示する場合）、そのアクティビティは、複数のインスタンスを起動できる必要があります。Android 10 以前を搭載しているデバイスでは、documentLaunchMode を明示的に "always" に設定しない限り、通知はバブルとして表示されます。Android 11 以降では、すべての会話の documentLaunchMode が自動的に "always" に設定されるため、この値を明示的に設定する必要はありません。

バブルを送信する手順は次のとおりです。

1. 通常どおりに通知を作成します。
2. BubbleMetadata.Builder(PendingIntent, Icon) または BubbleMetadata.Builder(String) を呼び出して BubbleMetadata オブジェクトを作成します。
3. setBubbleMetadata() を使用して、メタデータを通知に追加します。
4. Android 11 以降をターゲットとしている場合は、バブルのメタデータまたは通知が共有ショートカットを参照していることを確認します。
5. バブルとして表示される通知をキャンセルしないようにアプリを変更します。通知アクティビティがバブルとして起動されたかどうかを確認するには、Activity#isLaunchedFromBubble() を呼び出します。通知をキャンセルすると、バブルが画面から削除されます。バブルを開くと、それに関連付けられた通知が自動的に非表示になります。

次の例はそれらの手順を示しています。

Kotlin

// Create a bubble intent.
val target = Intent(context, BubbleActivity::class.java)
val bubbleIntent = PendingIntent.getActivity(context, 0, target, 0 /* flags */)
val category = "com.example.category.IMG_SHARE_TARGET"

val chatPartner = Person.Builder()
    .setName("Chat partner")
    .setImportant(true)
    .build()

// Create a sharing shortcut.
val shortcutId = generateShortcutId()
val shortcut =
   ShortcutInfo.Builder(mContext, shortcutId)
       .setCategories(setOf(category))
       .setIntent(Intent(Intent.ACTION_DEFAULT))
       .setLongLived(true)
       .setShortLabel(chatPartner.name)
       .build()

// Create a bubble metadata.
val bubbleData = Notification.BubbleMetadata.Builder(bubbleIntent,
            Icon.createWithResource(context, R.drawable.icon))
    .setDesiredHeight(600)
    .build()

// Create a notification, referencing the sharing shortcut.
val builder = Notification.Builder(context, CHANNEL_ID)
    .setContentIntent(contentIntent)
    .setSmallIcon(smallIcon)
    .setBubbleMetadata(bubbleData)
    .setShortcutId(shortcutId)
    .addPerson(chatPartner)

Java

// Create a bubble intent.
Intent target = new Intent(mContext, BubbleActivity.class);
PendingIntent bubbleIntent =
    PendingIntent.getActivity(mContext, 0, target, 0 /* flags */);

private val CATEGORY_TEXT_SHARE_TARGET =
    "com.example.category.IMG_SHARE_TARGET"

Person chatPartner = new Person.Builder()
        .setName("Chat partner")
        .setImportant(true)
        .build();

// Create a sharing shortcut.
private String shortcutId = generateShortcutId();
ShortcutInfo shortcut =
   new ShortcutInfo.Builder(mContext, shortcutId)
       .setCategories(Collections.singleton(CATEGORY_TEXT_SHARE_TARGET))
       .setIntent(Intent(Intent.ACTION_DEFAULT))
       .setLongLived(true)
       .setShortLabel(chatPartner.getName())
       .build();

// Create a bubble metadata.
Notification.BubbleMetadata bubbleData =
    new Notification.BubbleMetadata.Builder(bubbleIntent,
            Icon.createWithResource(context, R.drawable.icon))
        .setDesiredHeight(600)
        .build();

// Create a notification, referencing the sharing shortcut.
Notification.Builder builder =
    new Notification.Builder(mContext, CHANNEL_ID)
        .setContentIntent(contentIntent)
        .setSmallIcon(smallIcon)
        .setBubbleMetadata(bubbleData)
        .setShortcutId(shortcutId)
        .addPerson(chatPartner);

注: バブル表示される通知を初めて送信する場合は、IMPORTANCE_MIN 以上の通知チャンネルを使用していることを確認してください。

バブルが送信されたときにアプリがフォアグラウンドの場合は、重要度は無視され、バブルは常に表示されます（ユーザーがバブルをブロックしている場合は除きます）。

展開表示バブルを作成する

バブルを自動的に展開した状態で表示するように設定できます。ただし、この自動展開機能を使用するのは、たとえば、ユーザーがボタンをタップして新しいチャットを開始するときなど、バブル内に結果が表示されるようなアクションをユーザーが実行した場合に限ることをおすすめします。また、このような場合はさらに、バブル作成時に送信されるバブル開始通知も抑制することをおすすめします。

上記の動作を実現するには、setAutoExpandBubble() メソッドと setSuppressNotification() メソッドでフラグをセットします。

次の例は、バブルを自動的に展開状態にして表示するように構成する方法を示しています。

Kotlin

val bubbleMetadata = Notification.BubbleMetadata.Builder()
    .setDesiredHeight(600)
    .setIntent(bubbleIntent)
    .setAutoExpandBubble(true)
    .setSuppressNotification(true)
    .build()

Java

Notification.BubbleMetadata bubbleData =
    new Notification.BubbleMetadata.Builder()
        .setDesiredHeight(600)
        .setIntent(bubbleIntent)
        .setAutoExpandBubble(true)
        .setSuppressNotification(true)
        .build();

バブル コンテンツのライフサイクル

バブルが展開されると、コンテンツ アクティビティは通常のプロセス ライフサイクルを経て、アプリがフォアグラウンド プロセスに移行します（フォアグラウンドになかった場合）。

バブルを閉じたり閉じたりすると、アクティビティは破棄されます。その結果、アプリで他のフォアグラウンド コンポーネントが実行されているかどうかに応じて、プロセスがキャッシュされて後で強制終了されることになります。

バブルが表示されるタイミング

ユーザーの作業を中断する回数を減らすため、バブルは特定の状況でのみ表示されます。

アプリが Android 11 以降をターゲットにしている場合、会話要件を満たしていない限り、その通知はバブルとして表示されません。アプリが Android 10 以前をターゲットとしている場合、通知がバブルとして表示されるのは、以下の条件のうち、少なくとも 1 つが当てはまる場合に限られます。

• 通知で MessagingStyle が使用され、Person が追加されている。
• 通知は Service.startForeground の呼び出しからのものであり、category が CATEGORY_CALL で、Person が追加されています。
• 通知の送信時にアプリがフォアグラウンドで実行されている。

これらの条件が満たされない場合は、バブルの代わりに通知が表示されます。

注: Android 10 では、Bubbles は標準でサポートされていません。バブルを表示するには、開発者向けオプションを有効にして、設定メニューで「バブル」を検索し、バブルの設定を有効にする必要があります。

バブルからアクティビティを起動する

バブルが新しいアクティビティを起動すると、新しいアクティビティは同じタスクと同じバブル化されたウィンドウ内で起動するか、新しいタスクで全画面で起動します。その場合、起動したバブルは閉じられます。

バブルと同じタスクで新しいアクティビティを起動するには: 1. インテントを起動するときにアクティビティ コンテキスト、activity.startActivity(intent)、1 を使用します。インテントには FLAG_ACTIVITY_NEW_TASK フラグを設定しないでください。

それ以外の場合、新しいアクティビティは新しいタスクで開始され、バブルは閉じられます。

バブルは特定の会話を表すため、バブル内で起動するアクティビティはその会話に関連している必要があります。また、バブル内でアクティビティを起動すると、バブルのタスクスタックが増加し、特にナビゲーションに関するユーザー エクスペリエンスが複雑になる可能性があります。

おすすめの方法

• 通知をバブルとして送信するのは、進行中の通信など、重要度が高い場合や、ユーザーが明示的にバブル表示をリクエストしているコンテンツの場合だけに限るようにしてください。バブルは画面領域を占有し、他のアプリのコンテンツの上を覆います。
• バブル通知が通常の通知としても機能することを確認してください。ユーザーがバブルを無効にすると、バブル通知は通常の通知として表示されます。
• バブル アクティビティで onBackPressed をオーバーライドする場合は、super.onBackPressed を呼び出します。そうしないと、バブルが正しく動作しない可能性があります。

折りたたまれたバブルが更新されたメッセージを受け取ると、未読メッセージを示すバッジアイコンがバブルに表示されます。関連するアプリでユーザーがメッセージを開いた場合は、次のようにします。

• BubbleMetadata を更新して、通知を抑制します。BubbleMetadata.Builder.setSuppressNotification() を呼び出します。これにより、ユーザーがメッセージを操作したことを示すバッジアイコンが削除されます。
• BubbleMetadata の更新に付随する音やバイブレーションを抑制するには、Notification.Builder.setOnlyAlertOnce() を true に設定します。

サンプルアプリ

People サンプルアプリは、バブルを使用する会話型アプリです。デモ用に、このアプリではチャットボットを使用します。実際のアプリでは、バブルは人間によるメッセージに使用します。