@capgo/capacitor-live-activities

Gérez les Live Activities iOS et les layouts Dynamic Island depuis Capacitor avec des templates JSON

Aperçu

@capgo/capacitor-live-activities gère ActivityKit les Live Activities de Capacitor via un DSL de layout JSON (écran de verrouillage, Dynamic Island, minuteurs, images dans un App Group partagé). Il n'implémente pas Apple App Intents, les phrases Siri, l'application Shortcuts, l'indexation Spotlight ou une file d'App Intents en attente.

Pour les widgets sur l'écran d'accueil, les templates SVG ou LiveActivityIntent les boutons liés à un log d'événements de template, utilisez @capgo/capacitor-widget-kit à la place ou en complément de ce plugin. Pour les phrases Siri, Spotlight et une file d'attente App Intent en JavaScript, utilisez @capgo/capacitor-app-intents.

Consultez Siri, Raccourcis et widgets sur la façon dont Capgo plugins se lient aux fonctionnalités d'intégration système.

Commencez par areActivitiesSupported() et les autres méthodes principales listées ci-dessous.

Support des plateformes

Plateforme	Support	Notes
iOS	Oui	Natif
Android	Oui	Natif
Le Web	Non	Protéger avec Capacitor.getPlatform()

Démo

Fonctionnalités clés

areActivitiesSupported - Vérifier si les Live Activities sont prises en charge sur cet appareil. Nécessite iOS 16.1+ et un appareil compatible.
startActivity - Démarrer une nouvelle Live Activity avec le layout et les données spécifiés.
updateActivity - Mettre à jour une Live Activity existante avec de nouvelles données.
endActivity - Terminer une Live Activity.

API public

Méthode	Description
`areActivitiesSupported`	Vérifier si les Live Activities sont prises en charge sur cet appareil. Nécessite iOS 16.1+ et un appareil compatible.
`startActivity`	Démarrer une nouvelle Live Activity avec le layout et les données spécifiés.
`updateActivity`	Mettre à jour une Live Activity existante avec de nouvelles données.
`endActivity`	Terminer une Live Activity.
`getAllActivities`	Récupérer toutes les Live Activities actuellement actives.
`saveImage`	Enregistrer une image dans le conteneur partagé de l'App Group pour l'utiliser dans les Live Activities. Les images doivent être enregistrées dans ce conteneur partagé pour être accessibles depuis l'extension du widget.
`removeImage`	Supprimez une image enregistrée du conteneur partagé.
`listImages`	Listez toutes les images enregistrées dans le conteneur partagé.
`cleanupImages`	Supprimez toutes les images enregistrées du conteneur partagé.
`getPluginVersion`	Récupère la version du plugin natif Capacitor.
`startTimerSequence`	Lancer une séquence de timer pour le sport ou l'entraînement. Sur iOS : s'affiche dans la Live Activity et la Dynamic Island. Sur Android : s'affiche sous forme de notification de premier plan avec le timer.
`pauseTimerSequence`	Mettez la séquence de timer en pause.
`resumeTimerSequence`	Reprenez une séquence de timer en pause.
`stopTimerSequence`	Arrêtez et fermez la séquence de timer.
`skipTimerStep`	Passer à l'étape suivante de la séquence.
`previousTimerStep`	Revenir à l'étape précédente de la séquence.
`getTimerState`	Récupérer l'état actuel d'une séquence de timer.
`addListener`	Ajoutez un écouteur pour les événements de séquence du minuteur. Les événements incluent : stepChange, complete, tick, paused, resumed, stopped, loopComplete.

Source de vérité

Cette référence est synchronisée depuis src/definitions.ts dans capacitor-live-activities.

Continuer avec @capgo/capacitor-live-activities

Si vous utilisez @capgo/capacitor-live-activities pour planifier le comportement des médias et de l'interface natifs, connectez-l’à Utiliser @capgo/capacitor-live-activities pour la capacité native dans Utiliser @capgo/capacitor-live-activities Utiliser @capgo/capacitor-video-player pour la fonctionnalité native dans la section Utiliser @capgo/capacitor-video-player, @capgo/capacitor-video-player pour le détail d'implémentation dans @capgo/capacitor-video-player, Utilisation de @capgo/capacitor-native-navigation pour la capacité native dans Using @capgo/capacitor-native-navigation, et @capgo/capacitor-native-navigation pour le détail d'implémentation dans @capgo/capacitor-native-navigation.