Zarządzanie aplikacją GlanceAppWidget i ich aktualizowanie

W kolejnych sekcjach opisujemy, jak aktualizować GlanceAppWidget i zarządzać jego stanem.

Zarządzanie stanem GlanceAppWidget

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

Pojęcie stanu można podzielić na te kategorie:

  • Stan aplikacji: stan lub zawartość aplikacji wymagana przez widżet. Może to być np. lista zapisanych miejsc docelowych (czyli baza danych) zdefiniowana przez użytkownika.
  • Stan Glance: stan, który jest istotny tylko dla widżetu aplikacji i niekoniecznie modyfikuje ani wpływa na stan aplikacji. Może to być np. zaznaczenie pola wyboru w widżecie lub zwiększenie licznika.

Korzystanie ze stanu aplikacji

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

Na przykład ten kod pobiera miejsca docelowe z pamięci podręcznej w warstwie repozytorium, udostępnia zapisaną listę miejsc docelowych i wyświetla inny interfejs w zależności od 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
            }
        }
    }
}

Gdy stan lub dane się zmienią, aplikacja musi powiadomić widżet i go zaktualizować. Więcej informacji znajdziesz w artykule Aktualizowanie GlanceAppWidget.

Aktualizowanie GlanceAppWidget

Możesz poprosić o zaktualizowanie treści widżetu za pomocą GlanceAppWidget. Jak wyjaśniliśmy w sekcji Zarządzanie GlanceAppWidget stanem, widżety aplikacji są hostowane w innym procesie. Glance tłumaczy treści na rzeczywiste RemoteViews i wysyła je do hosta. Aby zaktualizować treści, Glance musi ponownie utworzyć RemoteViews i wysłać je ponownie.

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

MyAppWidget().update(context, glanceId)

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)
}

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
}

Te metody można wywoływać z dowolnej części aplikacji. Ponieważ są to funkcje suspend, zalecamy uruchamianie ich poza zakresem wątku głównego. 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()
    }
}

Więcej informacji o współprogramach znajdziesz w artykule Współprogramy Kotlin na Androidzie.

Kiedy aktualizować widżety

Aktualizuj widżety natychmiast lub okresowo.

Gdy aplikacja jest aktywna, widżet może się zaktualizować natychmiast. Przykład:

  • Gdy użytkownik wejdzie w interakcję z widżetem, co spowoduje wywołanie działania, lambdy lub intencji uruchomienia aktywności.
  • Gdy użytkownik wejdzie w interakcję z aplikacją na pierwszym planie lub gdy aplikacja jest już aktualizowana w odpowiedzi na wiadomość z Komunikacji w chmurze Firebase (FCM) lub transmisję.

W takich przypadkach wywołaj metodę update zgodnie z opisem w tym przewodniku.

Gdy aplikacja nie jest aktywna, widżet może się aktualizować okresowo. Przykład:

  • Użyj updatePeriodMillis, aby aktualizować widżet maksymalnie raz na 30 minut.
  • Użyj WorkManager, aby zaplanować częstsze aktualizacje, np. co 15 minut.
  • Zaktualizuj widżet w odpowiedzi na transmisję.

Zasoby

Wstecz
Śledzenie danych widżetu
Dalej
Tworzenie interfejsu użytkownika za pomocą Glance