Gestisci e aggiorna GlanceAppWidget

Le sezioni seguenti descrivono come aggiornare GlanceAppWidget e gestirne lo stato.

Gestire lo stato di GlanceAppWidget

La classe GlanceAppWidget fornita viene istanziata ogni volta che il widget viene creato o richiede un aggiornamento, pertanto deve essere stateless e passiva.

Il concetto di stato può essere suddiviso in:

  • Stato dell'applicazione: lo stato o il contenuto dell'app richiesto dal widget. Ad esempio, un elenco di destinazioni memorizzate (ovvero un database) definito dall'utente.
  • Stato di Glance: lo stato specifico pertinente solo al widget dell'app e che non modifica o influisce necessariamente sullo stato dell'app. Ad esempio, una casella di controllo è stata selezionata nel widget o un contatore è stato incrementato.

Utilizzare lo stato dell'applicazione

I widget dell'app devono essere passivi. Ogni applicazione è responsabile della gestione del livello dati e della gestione degli stati, ad esempio inattivo, caricamento ed errore, visualizzati nell'UI del widget.

Ad esempio, il seguente codice recupera le destinazioni dalla cache in memoria dal livello del repository, fornisce l'elenco memorizzato delle destinazioni e visualizza un'UI diversa a seconda del suo stato:

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

Ogni volta che lo stato o i dati cambiano, è responsabilità dell'app notificare e aggiornare il widget. Per ulteriori informazioni, vedi Aggiornare GlanceAppWidget.

Aggiornare GlanceAppWidget

Puoi richiedere di aggiornare i contenuti del widget utilizzando GlanceAppWidget. Come spiegato nella sezione Gestire lo GlanceAppWidgetstato, i widget dell'app sono ospitati in un processo diverso. Glance traduce i contenuti in RemoteViews effettivi e li invia all'host. Per aggiornare i contenuti, Glance deve ricreare i RemoteViews e inviarli di nuovo.

Per inviare l'aggiornamento, chiama il metodo update dell'istanza GlanceAppWidget, fornendo il context e il glanceId:

MyAppWidget().update(context, glanceId)

Per ottenere il glanceId, esegui una query su GlanceAppWidgetManager:

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

In alternativa, utilizza una delle estensioni 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
}

Questi metodi possono essere chiamati da qualsiasi parte dell'applicazione. Poiché sono funzioni suspend, ti consigliamo di avviarle al di fuori dell'ambito del thread principale. Nell'esempio seguente, vengono avviate in un 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()
    }
}

Per ulteriori dettagli sulle coroutine, vedi Coroutine Kotlin su Android.

Quando aggiornare i widget

Aggiorna i widget immediatamente o periodicamente.

Il widget può essere aggiornato immediatamente quando l'app è attiva. Ad esempio:

  • Quando un utente interagisce con un widget, attivando un'azione, una chiamata lambda o un intent per avviare un'attività.
  • Quando l'utente interagisce con l'app in primo piano o mentre l'app è già in fase di aggiornamento in risposta a un messaggio Firebase Cloud Messaging (FCM) o a una trasmissione.

In questi casi, chiama il update metodo come descritto in questa guida.

Il widget può essere aggiornato periodicamente quando l'app non è attiva. Ad esempio:

  • Utilizza updatePeriodMillis per aggiornare il widget al massimo una volta ogni 30 minuti.
  • Utilizza WorkManager per pianificare aggiornamenti più frequenti, ad esempio ogni 15 minuti.
  • Aggiorna il widget in risposta a una trasmissione.

Risorse

Indietro
Monitora le metriche per il widget
Avanti
Creazione di una UI in sintesi