管理和更新 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 状态部分所述,应用微件托管在不同的进程中。Glance 会将内容转换为实际的 RemoteViews 并将其发送到主机。要更新内容,Glance 必须重新创建 RemoteViews 并再次发送。

如需发送更新,请调用 GlanceAppWidget 实例的 update 方法,并提供 contextglanceId

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 协程