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

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

ユーザーがウィジェットを設定できるようにするには、ウィジェット構成 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>