Как управлять GlanceAppWidget и обновлять его

В разделах ниже описано, как обновить GlanceAppWidget и управлять его состоянием.

Управление статусом GlanceAppWidget

Предоставленный класс GlanceAppWidget создается каждый раз, когда создается или обновляется виджет, поэтому он должен быть пассивным и не иметь состояния.

Понятие состояния можно разделить на следующие категории:

• Состояние приложения. Состояние или контент приложения, необходимые для работы виджета. Например, список сохраненных пунктов назначения (то есть база данных), заданных пользователем.
• Состояние виджета. Состояние, которое относится только к виджету приложения и не обязательно изменяет или влияет на состояние приложения. Например, в виджете был установлен флажок или увеличен счетчик.

Как использовать состояние приложения

Виджеты приложений должны быть пассивными. Каждое приложение отвечает за управление уровнем данных и обработку состояний, таких как ожидание, загрузка и ошибка, которые отражаются в интерфейсе виджета.

Например, следующий код извлекает пункты назначения из кеша в памяти на уровне репозитория, предоставляет сохраненный список пунктов назначения и отображает другой интерфейс в зависимости от его состояния:

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
            }
        }
    }
}
GlanceSnippets.kt

При изменении состояния или данных приложение должно уведомить виджет и обновить его. Подробнее о том, как обновить GlanceAppWidget…

Обновление ПО: GlanceAppWidget

Вы можете запросить обновление контента виджета с помощью GlanceAppWidget. Как описано в разделе Управление состоянием GlanceAppWidget, виджеты приложений размещаются в другом процессе. Glance переводит контент в реальные RemoteViews и отправляет их организатору. Чтобы обновить контент, Glance должен заново создать RemoteViews и отправить их.

Чтобы отправить обновление, вызовите метод update экземпляра GlanceAppWidget, указав context и glanceId:

MyAppWidget().update(context, glanceId)
GlanceSnippets.kt

Чтобы получить glanceId, отправьте запрос к GlanceAppWidgetManager:

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

Вы также можете использовать одно из следующих 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
}
GlanceSnippets.kt

Эти методы можно вызывать из любой части приложения. Поскольку это функции 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()
    }
}
GlanceSnippets.kt

Подробнее о сопрограммах Kotlin в Android…

Когда обновлять виджеты

Обновлять виджеты сразу или периодически.

Когда приложение активно, виджет может обновляться сразу. Пример:

• Когда пользователь взаимодействует с виджетом, запуская действие, вызов лямбда-функции или намерение запустить активность.
• Когда пользователь взаимодействует с приложением, открытым на переднем плане, или когда приложение уже обновляется в ответ на сообщение Firebase Cloud Messaging (FCM) или широковещательную передачу.

В таких случаях вызывайте метод update, как описано в этом руководстве.

Виджет может периодически обновляться, даже когда приложение не запущено. Пример:

• Используйте updatePeriodMillis, чтобы обновлять виджет не чаще, чем раз в 30 минут.
• Используйте WorkManager, чтобы настроить более частые обновления, например каждые 15 минут.
• Обновлять виджет в ответ на широковещательную передачу.

Ресурсы

• Создание виджета с помощью Glance (практическая работа)
• Создание виджетов для Android (видео)