Zum Inhalt springen

@capgo/capacitor-live-activities

Verwalte iOS Live Activities und Dynamic-Island-Layouts via Capacitor mit JSON-basierten Templates

@capgo/capacitor-live-activities verwaltet ActivityKit Live Activities von Capacitor über eine JSON-Layout-DSL (Lockscreen, Dynamic Island, Timer, Bilder in einer gemeinsamen App Group). Es implementiert nicht Apple App-Intents, Siri-Phrasen, die Shortcuts-App, Spotlight-Indizierung oder eine Warteschlange für App Intents.

Für Home-Screen-Widgets, SVG-Templates oder LiveActivityIntent buttons tied to a template event log, use @capgo/capacitor-widget-kit stattdessen oder zusätzlich zu diesem Plugin. Für Siri-Phrasen, Spotlight und eine App Intent-Warteschlange in JavaScript verwende @capgo/capacitor-app-intents.

Siehe Siri, Shortcuts und Widgets hier, wie Capgo Plugins auf System-Integrationsfeatures gemappt werden.

Starte mit areActivitiesSupported() und den anderen unten aufgeführten Core-Methoden.

PlattformSupportNotizen
iOSJaNativ
AndroidJaNativ
WebNeinAbsichern mit Capacitor.getPlatform()
Animierte Live Activities Demo mit Sperrbildschirm- und Dynamic Island Updates von Capacitor
Live-Activity- und Dynamic-Island-Updates
  • areActivitiesSupported - Prüfen, ob Live Activities auf diesem Gerät unterstützt werden. Erfordert iOS 16.1+ und Geräteunterstützung.
  • startActivity - Eine neue Live Activity mit dem angegebenen Layout und den angegebenen Daten starten.
  • updateActivity - Eine bestehende Live Activity mit neuen Daten aktualisieren.
  • endActivity - Eine Live Activity beenden.
MethodeBeschreibung
areActivitiesSupportedPrüfen, ob Live Activities auf diesem Gerät unterstützt werden. Erfordert iOS 16.1+ und Geräteunterstützung.
startActivityEine neue Live Activity mit dem angegebenen Layout und den angegebenen Daten starten.
updateActivityEine bestehende Live Activity mit neuen Daten aktualisieren.
endActivityEine Live Activity beenden.
getAllActivitiesAlle aktuell aktiven Live Activities abrufen.
saveImageSpeichere ein Bild im gemeinsamen App Group Container für die Nutzung in Live Activities. Bilder müssen im gemeinsamen Container gespeichert werden, damit sie über die Widget Extension zugänglich sind.
removeImageEntfernt ein gespeichertes Bild aus dem gemeinsamen Container.
listImagesListet alle im gemeinsamen Container gespeicherten Bilder auf.
cleanupImagesEntfernt alle gespeicherten Bilder aus dem gemeinsamen Container.
getPluginVersionDie native Capacitor Plugin-Version abrufen.
startTimerSequenceStarte eine Timer-Sequenz für Workouts/Sport. Auf iOS: Wird in der Live Activity und Dynamic Island angezeigt. Auf Android: Wird als Foreground-Benachrichtigung mit Timer angezeigt.
pauseTimerSequencePausiere die Timer-Sequenz.
resumeTimerSequenceSetze eine pausierte Timer-Sequenz fort.
stopTimerSequenceStoppe und schließe die Timer-Sequenz.
skipTimerStepSpringe zum nächsten Schritt der Sequenz.
previousTimerStepGehe zum vorherigen Schritt der Sequenz zurück.
getTimerStateRufe den aktuellen Status einer Timer-Sequenz ab.
addListenerFüge einen Listener für Timer-Sequenz-Events hinzu. Events: stepChange, complete, tick, paused, resumed, stopped, loopComplete.

Diese Referenz wird synchronisiert von src/definitions.ts in capacitor-live-activities.

Wenn du es nutzt @capgo/capacitor-live-activities , um natives Media- und Interface-Verhalten zu planen, verbinde es mit @capgo/capacitor-live-activities verwenden für die native Funktion in „@capgo/capacitor-live-activities verwenden“, Verwendung von @capgo/capacitor-video-player für die native Funktion bei Verwendung von @capgo/capacitor-video-player, @capgo/capacitor-video-player für das Implementierungsdetail in @capgo/capacitor-video-player, Verwendung von @capgo/capacitor-native-navigation für die native Funktionalität in Using @capgo/capacitor-native-navigation und @capgo/capacitor-native-navigation für das Implementierungsdetail in @capgo/capacitor-native-navigation.