概要
概要セクションCapacitor Live Activities プラグインのインターフェイスです。iOS Live Activitiesを管理するために使用されます。
基本機能
基本機能セクションareActivitiesSupported- このデバイスでLive Activitiesがサポートされているかどうかを確認します。iOS 16.1以上とデバイスのサポートが必要です。startActivity- 指定されたレイアウトとデータで新しいLive Activityを開始します。updateActivity- 既存のLive Activityに新しいデータを更新します。endActivity- Live Activityを終了します。
パブリック API
パブリック API セクション| メソッド | Live Activity のサポート状況を確認します。iOS 16.1 以降とデバイスのサポートが必要です。 |
|---|---|
areActivitiesSupported | 指定されたレイアウトとデータで新しい Live Activity を開始します。 |
startActivity | 既存の Live Activity に新しいデータで更新します。 |
updateActivity | Live Activity を終了します。 |
endActivity | 現在アクティブなすべての Live Activity を取得します。 |
getAllActivities | Live Activity で使用する共有 App Group コンテナに画像を保存します。画像は共有コンテナに保存する必要があります。共有コンテナからウィジェット拡張でアクセスできます。 |
saveImage | 共有コンテナから保存した画像を削除します。 |
removeImage | 共有コンテナに保存されているすべての画像をリストします。 |
listImages | 共有コンテナからすべての画像を削除します。 |
cleanupImages | ネイティブ __CAPGO_KEEP_0__ プラグインのバージョンを取得します。 |
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 | タイマーシーケンスを一時停止します。 |
resumeTimerSequence | 一時停止中のタイマーシーケンスを再開します。 |
stopTimerSequence | タイマーシーケンスを停止し、ダイアログを閉じます。 |
skipTimerStep | シーケンスの次のステップに進みます。 |
previousTimerStep | シーケンスの前のステップに戻ります。 |
getTimerState | タイマーシーケンスの現在の状態を取得します。 |
addListener | タイマーシーケンスのイベントにリスナーを追加します。イベントには、ステップ変更、完了、チック、一時停止、再開、停止、ループ完了が含まれます。 |
真実の源
「真実の源」というセクションこのリファレンスは src/definitions.ts __CAPGO_KEEP_0__-live-activities capacitor-live-activities.