アプリ ウィジェットは構成可能です。たとえば、時計ウィジェットでは、表示するタイムゾーンをユーザーが設定できます。
ユーザーにウィジェットの設定を許可したい場合は、ウィジェットを作成します
設定 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()は以後の更新のときには呼び出されます。スキップされるのは初回だけです。
レスポンスを返す方法の例については、次のセクションのコード スニペットをご覧ください。 更新し、ウィジェットを更新します。
設定アクティビティからウィジェットを更新する
ウィジェットが構成アクティビティを使用する場合、そのウィジェットは
構成完了後にウィジェットを更新するアクティビティです。そうすれば、
Google Cloud コンソールから
AppWidgetManager。
ウィジェットを適切に更新して設定アクティビティを閉じる手順の概要は以下のとおりです。
アクティビティを起動したインテントからアプリ ウィジェット 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); }
アクティビティの結果を
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);
ユーザーの好みに応じてウィジェットを設定します。
設定が完了したら、Cloud Storage バケットの
getInstance(Context)を呼び出してAppWidgetManagerします。Kotlin
val appWidgetManager = AppWidgetManager.getInstance(context)
Java
AppWidgetManager appWidgetManager = AppWidgetManager.getInstance(context);
ウィジェットを
RemoteViewsレイアウトを呼び出すには、updateAppWidget(int,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);
返すインテントを作成し、アクティビティの結果で設定してから、アクティビティを終了します。
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();
詳しくは、
ListWidgetConfigureActivity.kt
サンプルクラスをご覧ください。
ウィジェットの設定オプション
デフォルトでは、アプリ ウィジェット ホストは構成アクティビティを 1 回だけ起動します。 ユーザーがウィジェットをホーム画面に追加した直後。ただし、デフォルトのウィジェット構成を指定して、ユーザーが既存のウィジェットを再構成できるようにしたり、ウィジェットの初期構成をスキップできるようにしたりするオプションを指定できます。
配置したウィジェットをユーザーが再設定できるようにする
ユーザーが既存のウィジェットを再構成できるようにするには、appwidget-provider の widgetFeatures 属性に reconfigurable フラグを指定します。詳しくは、
AppWidgetProviderInfo.xml ファイルをご覧ください。
情報です。例:
<appwidget-provider
android:configure="com.myapp.ExampleAppWidgetConfigurationActivity"
android:widgetFeatures="reconfigurable">
</appwidget-provider>
ユーザーは、ウィジェットを長押しして [再設定] ボタン（図 1 の 1）をタップすることで、ウィジェットを再設定できます。
ウィジェットのデフォルト設定を使用する
ユーザーが
行います。これを行うには、両方の
configuration_optional
widgetFeatures フィールドの reconfigurable フラグ。これにより、ユーザーがウィジェットを追加した後の設定アクティビティの起動が省略されます前述のとおり、ユーザーは後でウィジェットを再設定できます。たとえば、時計ウィジェットは初期設定をバイパスして、
デバイスのタイムゾーンをデフォルトで表示します。
構成アクティビティを再構成可能かつ省略可能としてマークする方法の例を次に示します。
<appwidget-provider
android:configure="com.myapp.ExampleAppWidgetConfigurationActivity"
android:widgetFeatures="reconfigurable|configuration_optional">
</appwidget-provider>