ユーザーがアプリ ウィジェットを設定できるようにする

アプリ ウィジェットは構成可能です。たとえば、時計ウィジェットでは、表示するタイムゾーンをユーザーが設定できます。

ユーザーがウィジェットの設定を構成できるようにするには、ウィジェット構成 Activity を作成します。このアクティビティは、指定した設定オプションに応じて、ウィジェットの作成時またはそれ以降にアプリ ウィジェット ホストによって自動的に起動されます。

構成アクティビティを宣言する

設定アクティビティは、Android マニフェスト ファイルの通常のアクティビティとして宣言します。アプリ ウィジェット ホストが ACTION_APPWIDGET_CONFIGURE アクションで起動するため、このアクティビティがこのインテントを受け入れるようにする必要があります。例:

<activity android:name=".ExampleAppWidgetConfigurationActivity">
    <intent-filter>
        <action android:name="android.appwidget.action.APPWIDGET_CONFIGURE"/>
    </intent-filter>
</activity>

AppWidgetProviderInfo.xml ファイルで android:configure 属性を使用してアクティビティを宣言します。このファイルの宣言の詳細をご覧ください。構成アクティビティを宣言する方法の例を次に示します。

<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
    ...
    android:configure="com.example.android.ExampleAppWidgetConfigurationActivity"
    ... >
</appwidget-provider>

アクティビティは、完全修飾名前空間を使用して宣言されています。これは、ランチャーがパッケージ範囲の外からアクティビティを参照するためです。

構成アクティビティを開始するにあたって必要な作業は以上です。次に、実際のアクティビティを実装する必要があります。

構成アクティビティを実装する

アクティビティを実装する際には、次の 2 つの点に注意してください。

  • アプリ ウィジェット ホストが設定アクティビティを呼び出し、設定アクティビティが常に結果を返すようにします。結果には、アクティビティを起動したインテントから渡されたアプリ ウィジェット ID（インテントのエクストラに EXTRA_APPWIDGET_ID として保存される）が含まれている必要があります。
  • 設定アクティビティが起動されたときに、システムから ACTION_APPWIDGET_UPDATE ブロードキャストは送信されません。つまり、ウィジェットが作成されたときに onUpdate() メソッドは呼び出されません。ウィジェットを初めて作成するときに AppWidgetManager から更新をリクエストするのは設定アクティビティの責任です。ただし、onUpdate() は以後の更新のときには呼び出されます。スキップされるのは初回だけです。

設定から結果を返してウィジェットを更新する方法の例として、次のセクションのコード スニペットをご覧ください。

設定アクティビティからウィジェットを更新する

ウィジェットで設定アクティビティを使用する場合、設定完了時にウィジェットを更新することはアクティビティの責任です。これを行うには、AppWidgetManager から直接更新をリクエストします。

ウィジェットを適切に更新して設定アクティビティを閉じる手順の概要は以下のとおりです。

  1. アクティビティを起動したインテントからアプリ ウィジェット ID を取得します。

    Kotlin

    val appWidgetId = intent?.extras?.getInt(
        AppWidgetManager.EXTRA_APPWIDGET_ID,
        AppWidgetManager.INVALID_APPWIDGET_ID
) ?: AppWidgetManager.INVALID_APPWIDGET_ID

    Java

    Intent intent = getIntent();
Bundle extras = intent.getExtras();
int appWidgetId = AppWidgetManager.INVALID_APPWIDGET_ID;
if (extras != null) {
    appWidgetId = extras.getInt(
            AppWidgetManager.EXTRA_APPWIDGET_ID,
            AppWidgetManager.INVALID_APPWIDGET_ID);
}

  2. アクティビティの結果を RESULT_CANCELED に設定します。

    そのようにすると、ユーザーが最後まで完了する前にアクティビティを停止した場合、設定がキャンセルされたことがアプリ ウィジェット ホストに通知され、ホストはウィジェットを追加しません。

    Kotlin

    val resultValue = Intent().putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId)
setResult(Activity.RESULT_CANCELED, resultValue)

    Java

    int resultValue = new Intent().putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId);
setResult(Activity.RESULT_CANCELED, resultValue);

  3. ユーザーの設定に応じてウィジェットを構成します。

  4. 構成が完了したら、getInstance(Context) を呼び出して AppWidgetManager のインスタンスを取得します。

    Kotlin

    val appWidgetManager = AppWidgetManager.getInstance(context)

    Java

    AppWidgetManager appWidgetManager = AppWidgetManager.getInstance(context);

  5. updateAppWidget(int,RemoteViews) を呼び出して、RemoteViews レイアウトでウィジェットを更新します。

    Kotlin

    val views = RemoteViews(context.packageName, R.layout.example_appwidget)
appWidgetManager.updateAppWidget(appWidgetId, views)

    Java

    RemoteViews views = new RemoteViews(context.getPackageName(), R.layout.example_appwidget);
appWidgetManager.updateAppWidget(appWidgetId, views);

  6. 返すインテントを作成し、アクティビティの結果で設定してから、アクティビティを終了します。

    Kotlin

    val resultValue = Intent().putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId)
setResult(Activity.RESULT_OK, resultValue)
finish()

    Java

    Intent resultValue = new Intent().putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId);
setResult(RESULT_OK, resultValue);
finish();

例については、GitHub の ListWidgetConfigureActivity.kt サンプルクラスをご覧ください。

ウィジェットの設定オプション

デフォルトでは、アプリ ウィジェット ホストは、ユーザーがウィジェットをホーム画面に追加した直後に、設定アクティビティを 1 回だけ起動します。ただし、デフォルトのウィジェット構成を指定して、ユーザーが既存のウィジェットを再構成できるようにしたり、ウィジェットの初期構成をスキップできるようにしたりするオプションを指定できます。

配置したウィジェットをユーザーが再設定できるようにする

ユーザーが既存のウィジェットを再構成できるようにするには、appwidget-provider の widgetFeatures 属性に reconfigurable フラグを指定します。詳しくは、AppWidgetProviderInfo.xml ファイルを宣言するガイドをご覧ください。例:

<appwidget-provider
    android:configure="com.myapp.ExampleAppWidgetConfigurationActivity"
    android:widgetFeatures="reconfigurable">
</appwidget-provider>

ユーザーは、ウィジェットを長押しして [再設定] ボタン（図 1 の 1）をタップすることで、ウィジェットを再設定できます。

右下にボタンが表示される
図 1. ウィジェットの [再構成] ボタン。

ウィジェットのデフォルト設定を使用する

ユーザーが最初の構成手順をスキップできるようにすることで、よりシームレスなウィジェット エクスペリエンスを提供できます。これを行うには、widgetFeatures フィールドに configuration_optional フラグと reconfigurable フラグの両方を指定します。これにより、ユーザーがウィジェットを追加した後の設定アクティビティの起動が省略されます前述のとおり、ユーザーは後でウィジェットを再設定できます。たとえば、時計ウィジェットでは初期設定を省略して、デフォルトでデバイスのタイムゾーンを表示できます。

構成アクティビティを再構成可能かつ省略可能な両方としてマークする方法の例を次に示します。

<appwidget-provider
    android:configure="com.myapp.ExampleAppWidgetConfigurationActivity"
    android:widgetFeatures="reconfigurable|configuration_optional">
</appwidget-provider>