Vai al contenuto

@capgo/capacitor-live-activities

Gestisci i layout di iOS Live Activities e Dynamic Island da Capacitor con template basati su JSON

@capgo/capacitor-live-activities gestisce ActivityKit le Live Activities di Capacitor tramite un DSL di layout JSON (lock screen, Dynamic Island, timer, immagini in un App Group condiviso). Non implementa le funzionalità Apple Intent dell'app, le frasi di Siri, l'app Shortcuts, l'indicizzazione Spotlight o una coda di App Intent in sospeso.

Per i widget della Home Screen, i template SVG o LiveActivityIntent pulsanti collegati a un log di eventi del template, usa @capgo/capacitor-widget-kit in alternativa o insieme a questo plugin. Per frasi di Siri, Spotlight e una coda di App Intent in JavaScript, usa @capgo/capacitor-app-intents.

Vedi Siri, Shortcuts e widget su come i plugin Capgo si mappano alle funzionalità di integrazione di sistema.

Inizia con areActivitiesSupported() e gli altri metodi principali elencati qui sotto.

PiattaformaSupportoNote
iOSSìNativo
AndroidSìNativo
WebNoProteggi con Capacitor.getPlatform()
Demo animata delle Live Activities con aggiornamenti su lock screen e Dynamic Island da Capacitor
Aggiornamenti Live Activity e Dynamic Island
  • areActivitiesSupported - Verifica se le Live Activities sono supportate su questo dispositivo. Richiede iOS 16.1+ e supporto del dispositivo.
  • startActivity - Avvia una nuova Live Activity con il layout e i dati specificati.
  • updateActivity - Aggiorna una Live Activity esistente con nuovi dati.
  • endActivity - Termina una Live Activity.
MetodoDescrizione
areActivitiesSupportedVerifica se le Live Activities sono supportate su questo dispositivo. Richiede iOS 16.1+ e supporto del dispositivo.
startActivityAvvia una nuova Live Activity con il layout e i dati specificati.
updateActivityAggiorna una Live Activity esistente con nuovi dati.
endActivityTermina una Live Activity.
getAllActivitiesRecupera tutte le Live Activities attualmente attive.
saveImageSalva un'immagine nel container condiviso dell'App Group per usarla nelle Live Activities. Le immagini devono essere salvate nel container condiviso per essere accessibili dall'estensione del widget.
removeImageRimuovi un'immagine salvata dal container condiviso.
listImagesElenca tutte le immagini salvate nel container condiviso.
cleanupImagesRimuovi tutte le immagini salvate dal container condiviso.
getPluginVersionOttieni la versione nativa del plugin Capacitor.
startTimerSequenceAvvia una sequenza di timer per allenamenti o sport. Su iOS: appare nella Live Activity e nella Dynamic Island. Su Android: appare come notifica in primo piano con il timer.
pauseTimerSequenceMetti in pausa la sequenza del timer.
resumeTimerSequenceRiprendi una sequenza del timer in pausa.
stopTimerSequenceFerma e chiudi la sequenza del timer.
skipTimerStepSalta al passaggio successivo della sequenza.
previousTimerStepTorna allo step precedente della sequenza.
getTimerStateOttieni lo stato attuale di una sequenza timer.
addListenerAggiungi un listener per gli eventi della sequenza timer. Gli eventi includono: stepChange, complete, tick, paused, resumed, stopped, loopComplete.

Questo riferimento è sincronizzato da src/definitions.ts nella capacitor-live-activities.

Se stai usando @capgo/capacitor-live-activities per pianificare il comportamento dei media nativi e dell'interfaccia, collegalo a Uso di @capgo/capacitor-live-activities per la funzionalità nativa nella pagina Uso di @capgo/capacitor-live-activities, Uso di @capgo/capacitor-video-player per la funzionalità nativa in Utilizzo di @capgo/capacitor-video-player, @capgo/capacitor-video-player per i dettagli di implementazione in @capgo/capacitor-video-player, Usando @capgo/capacitor-native-navigation per la funzionalità nativa in Using @capgo/capacitor-native-navigation, e @capgo/capacitor-native-navigation per i dettagli di implementazione in @capgo/capacitor-native-navigation.