自動入力を IME および自動入力サービスと統合する

Android 11 以降、キーボードやその他のインプットメソッドエディタ（IME）は、自動入力候補をシステムがメニューに表示するのではなく、候補領域またはそれに類似するものにインライン表示できます。こうした自動入力候補にはパスワードやクレジットカード情報などのプライベートデータが含まれることがあるため、ユーザーが選択するまで、候補は IME に表示されません。この機能を使用するには、IME と自動入力サービス（パスワードマネージャーなど）を更新する必要があります。IME または自動入力サービスがインライン自動入力をサポートしていない場合、候補はメニューに表示されます。これは、Android 11 より前のバージョンと同様です。

ワークフロー

このフローで、IMEは現在のキーボードまたは他の入力エディタを意味し、 候補プロバイダはその自動入力候補の該当するプロバイダを意味します。入力フィールドとユーザーの設定に応じて、候補プロバイダはプラットフォームか自動入力サービスになります。

ユーザーが、自動入力をトリガーする入力フィールド（パスワードやクレジットカードの入力フィールドなど）にフォーカスします。
プラットフォームが、現在の IME と該当する候補プロバイダにクエリを行い、インライン自動入力をサポートしているかどうかを確認します。IME または候補プロバイダがインライン自動入力をサポートしていない場合は、Android 10 以前と同様に、候補がメニューに表示されます。
プラットフォームが IME に対し、「候補リクエスト」を提供するよう求めます。この候補リクエストは、表示する候補の最大数を指定し、各候補の「表示仕様」も提供します。表示仕様では最大サイズ、テキストサイズ、色、フォントデータなどを指定し、候補プロバイダは IME のデザインに合わせることができます。
プラットフォームが候補プロバイダに対し、リクエストされた候補数まで候補を提供するよう求めます。各候補には、候補の UI を含む View をインフレートするためのコールバックが含まれます。
プラットフォームが IME に対し、候補の準備ができたことを通知します。IME は、コールバックメソッドを呼び出して各候補の View をインフレートすることで候補を表示します。ユーザーの個人情報を保護するため、この段階では IME は候補の内容を認識しません。
ユーザーが候補のいずれかを選択すると、ユーザーがシステムメニューから候補を選択した場合と同様に、IME に通知されます。

以下のセクションでは、インライン自動入力をサポートするように IME または自動入力サービスを構成する方法について説明します。

インライン自動入力をサポートするように IME を構成する

このセクションでは、インライン自動入力をサポートするように IME を構成する方法について説明します。IME がインライン自動入力をサポートしていない場合、プラットフォームはデフォルトで、メニューに自動入力候補を表示します。

IME は属性を supportsInlinedSuggestions に設定する必要がありますtrue。

<input-method
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:supportsInlineSuggestions="true"/>

プラットフォームで自動入力候補が必要になると、IME の InputMethodService.onCreateInlineSuggestionsRequest() メソッドが呼び出されます。このメソッドを実装する必要があります。次のものを指定するInlineSuggestionsRequest を返します。

IME が求める候補数 。
各候補の InlinePresentationSpec。候補の表示方法を定義します。

注: 指定した表示仕様がリクエストされた候補数よりも少ない場合、残りすべての候補に対し、最後の仕様が使用されます。たとえば表示仕様を 1 つだけ指定した場合、候補プロバイダは、その仕様をすべての候補に使用します。

候補がある場合、プラットフォームは IME の onInlineSuggestionsResponse() メソッドを呼び出し、候補を含む InlineSuggestionsResponse を渡します。このメソッドを実装する必要があります。実装では、 InlineSuggestionsResponse.getInlineSuggestions()を呼び出して候補のリストを取得し、 InlineSuggestion.inflate() メソッドを呼び出して各候補をインフレートします。

インライン自動入力をサポートするように自動入力サービスを構成する

このセクションでは、インライン自動入力をサポートするように自動入力サービスを構成する方法について説明します。アプリがインライン自動入力をサポートしていない場合、プラットフォームはデフォルトで、メニューに自動入力候補を表示します。

自動入力サービスは属性を true にsupportsInlinedSuggestions設定する必要があります。

<autofill-service
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:supportsInlineSuggestions="true"/>

IME で自動入力候補が必要になると、プラットフォームは自動入力サービス's onFillRequest() メソッドを、Android 11 より前のバージョンと同様に呼び出します。ただし、サービスは渡された FillRequest オブジェクトの getInlineSuggestionsRequest() メソッドを呼び出す必要があります。これにより、IME によって作成された InlineSuggestionsRequest が取得されます。InlineSuggestionsRequest は、必要なインライン候補の数と、各候補の表示方法を指定します。IME がインライン候補をサポートしていない場合、メソッドは null を返します。

自動入力サービスは、InlinePresentation オブジェクトを、 InlineSuggestionsRequest でリクエストされた最大数まで作成します。表示は、InlineSuggestionsRequest で指定されたサイズの制約に従う必要があります。候補を IME に返すには、候補ごとに Dataset.Builder.setValue() を 1 回呼び出します。Android 11 には、インライン候補をサポートする Dataset.Builder.setValue() のバージョンが用意されています。