Zarządzanie aplikacją GlanceAppWidget i ich aktualizowanie

W sekcjach poniżej dowiesz się, jak zaktualizować zasób GlanceAppWidget i zarządzać jego stanem.

Zarządzaj stanem: GlanceAppWidget

Podana klasa GlanceAppWidget jest tworzona za każdym razem, gdy widżet zostanie utworzony lub wymaga aktualizacji, dlatego powinna być bezstanowa i pasywna.

Pojęcie państwa można podzielić na następujące kategorie:

• Stan aplikacji: stan lub zawartość aplikacji wymagane przez widżet. Może to być na przykład lista przechowywanych miejsc docelowych (tj. bazy danych) zdefiniowanych przez użytkownika.
• Stan podglądu: konkretny stan, który dotyczy tylko widżetu aplikacji i nie musi zmieniać ani wpływać na stan aplikacji. np. zaznaczenie pola wyboru w widżecie lub zwiększenie licznika.

Użyj stanu aplikacji

Widżety aplikacji powinny być pasywne. Każda aplikacja odpowiada za zarządzanie warstwą danych i obsługę stanów, takich jak bezczynność, wczytywanie i błędy, które są odzwierciedlane w interfejsie widżetu.

Na przykład ten kod pobiera miejsca docelowe z pamięci podręcznej z warstwy repozytorium, dostarcza zapisane listy miejsc docelowych i wyświetla inny interfejs w zależności od ich stanu:

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

Za każdym razem, gdy stan lub dane się zmieniają, obowiązkiem aplikacji jest powiadamianie i aktualizowanie widżetu. Więcej informacji znajdziesz w artykule Aktualizowanie GlanceAppWidget.

Aktualizuj aplikację GlanceAppWidget

Jak wyjaśniliśmy w sekcji Zarządzanie stanem GlanceAppWidget, widżety aplikacji są hostowane w innym procesie. Funkcja Glance tłumaczy treści na rzeczywiste RemoteViews i wysyła je do gospodarza. Aby zaktualizować treści, Glance musi odtworzyć plik RemoteViews i wysłać je jeszcze raz.

Aby wysłać aktualizację, wywołaj metodę update instancji GlanceAppWidget, podając context i glanceId:

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

Aby uzyskać glanceId, wyślij zapytanie do GlanceAppWidgetManager:

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

Możesz też użyć jednego z rozszerzeń 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

Te metody można wywoływać z dowolnej części aplikacji. Ponieważ są to funkcje suspend, zalecamy ich uruchamianie poza zakresem głównym wątku. W tym przykładzie są one uruchamiane w 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

Więcej informacji o koderach znajdziesz na stronie Kotlin Coroutines na Androidzie.