@capgo/capacitor-live-activities

Overview

Capacitor Live Activities Plugin interface for managing iOS Live Activities.

Core Capabilities

• areActivitiesSupported - Check if Live Activities are supported on this device. Requires iOS 16.1+ and device support.
• startActivity - Start a new Live Activity with the specified layout and data.
• updateActivity - Update an existing Live Activity with new data.
• endActivity - End a Live Activity.

Public API

Method	Description
areActivitiesSupported	Check if Live Activities are supported on this device. Requires iOS 16.1+ and device support.
startActivity	Start a new Live Activity with the specified layout and data.
updateActivity	Update an existing Live Activity with new data.
endActivity	End a Live Activity.
getAllActivities	Get all currently active Live Activities.
saveImage	Save an image to the shared App Group container for use in Live Activities. Images must be saved to the shared container to be accessible from the widget extension.
removeImage	Remove a saved image from the shared container.
listImages	List all saved images in the shared container.
cleanupImages	Remove all saved images from the shared container.
getPluginVersion	Get the native Capacitor plugin version.
startTimerSequence	Start a timer sequence for workouts/sports. On iOS: Shows in Live Activity and Dynamic Island On Android: Shows as a foreground notification with timer.
pauseTimerSequence	Pause the timer sequence.
resumeTimerSequence	Resume a paused timer sequence.
stopTimerSequence	Stop and dismiss the timer sequence.
skipTimerStep	Skip to the next step in the sequence.
previousTimerStep	Go back to the previous step in the sequence.
getTimerState	Get the current state of a timer sequence.
addListener	Add a listener for timer sequence events. Events include: stepChange, complete, tick, paused, resumed, stopped, loopComplete.

Source Of Truth

This reference is synced from src/definitions.ts in capacitor-live-activities.