GlanceAppWidget を管理、更新する

以降のセクションでは、GlanceAppWidget を更新してその状態を管理する方法について説明します。

GlanceAppWidget の状態を管理する

指定された GlanceAppWidget クラスは、ウィジェットが作成されるか、更新が必要になるたびにインスタンス化されるため、ステートレスかつパッシブである必要があります。

状態のコンセプトは、次のように分類できます。

  • アプリケーションの状態: ウィジェットが必要とするアプリの状態またはコンテンツ。たとえば、ユーザーが定義した保存先（データベースなど）のリスト。
  • Glance の状態: アプリ ウィジェットにのみ関連する特定の状態。アプリの状態を変更したり、影響を与えたりするとは限りません。たとえば、ウィジェットでチェックボックスがオンになった、カウンタが増加したなどです。

アプリケーションの状態を使用する

アプリ ウィジェットは受動的である必要があります。各アプリケーションは、データレイヤの管理と、ウィジェット UI に反映されるアイドル、読み込み、エラーなどの状態の処理を担当します。

たとえば、次のコードは、リポジトリ レイヤからメモリ キャッシュから目的地を取得し、保存されている目的地のリストを提供して、その状態に応じて異なる UI を表示します。

class DestinationAppWidget : GlanceAppWidget() {

    // ...

    @Composable
    fun MyContent() {
        val repository = remember { DestinationsRepository.getInstance() }
        // Retrieve the cache data everytime the content is refreshed
        val destinations by repository.destinations.collectAsState(State.Loading)

        when (destinations) {
            is State.Loading -> {
                // show loading content
            }

            is State.Error -> {
                // show widget error content
            }

            is State.Completed -> {
                // show the list of destinations
            }
        }
    }
}

状態またはデータが変更された場合は、アプリがウィジェットに通知して更新する必要があります。詳しくは、GlanceAppWidget を更新するをご覧ください。

GlanceAppWidget を更新します

GlanceAppWidget を使用して、ウィジェットのコンテンツの更新をリクエストできます。GlanceAppWidget 状態を管理するセクションで説明したように、アプリ ウィジェットは別のプロセスでホストされます。Glance は、コンテンツを実際の RemoteViews に変換してホストに送信します。コンテンツを更新するには、Glance で RemoteViews を再作成して再度送信する必要があります。

更新を送信するには、GlanceAppWidget インスタンスの update メソッドを呼び出し、context と glanceId を指定します。

MyAppWidget().update(context, glanceId)

glanceId を取得するには、GlanceAppWidgetManager をクエリします。

val manager = GlanceAppWidgetManager(context)
val widget = GlanceSizeModeWidget()
val glanceIds = manager.getGlanceIds(widget.javaClass)
glanceIds.forEach { glanceId ->
    widget.update(context, glanceId)
}

または、次のいずれかの GlanceAppWidget update 拡張機能を使用します。

// Updates all placed instances of MyAppWidget
MyAppWidget().updateAll(context)

// Iterate over all placed instances of MyAppWidget and update if the state of
// the instance matches the given predicate
MyAppWidget().updateIf<State>(context) { state ->
    state == State.Completed
}

これらのメソッドは、アプリケーションの任意の場所から呼び出すことができます。これらは suspend 関数であるため、メインスレッド スコープ外で起動することをおすすめします。次の例では、CoroutineWorker で起動されます。

class DataSyncWorker(
    val context: Context,
    val params: WorkerParameters,
) : CoroutineWorker(context, params) {

    override suspend fun doWork(): Result {
        // Fetch data or do some work and then update all instance of your widget
        MyAppWidget().updateAll(context)
        return Result.success()
    }
}

コルーチンの詳細については、Android での Kotlin コルーチンをご覧ください。

ウィジェットを更新するタイミング

ウィジェットを即時または定期的に更新する。

アプリが起動しているときにウィジェットをすぐに更新できます。次に例を示します。

  • ユーザーがウィジェットを操作して、アクション、ラムダ呼び出し、またはアクティビティを起動するインテントをトリガーしたとき。
  • ユーザーがフォアグラウンドでアプリを操作しているとき、または Firebase Cloud Messaging（FCM）メッセージやブロードキャストに応じてアプリがすでに更新されているとき。

このような場合は、このガイドで説明されているように update メソッドを呼び出します。

アプリが起動していないときに、ウィジェットを定期的に更新できます。次に例を示します。

  • updatePeriodMillis を使用して、ウィジェットを 30 分に 1 回まで更新します。
  • WorkManager を使用して、15 分ごとなど、より頻繁な更新をスケジュールします。
  • ブロードキャストに応じてウィジェットを更新する。

リソース

前へ
ウィジェットの指標を追跡する
次へ
Glance で UI を作成する