@capgo/capacitor-live-activities を管理します ActivityKit の Capacitor による Live Activities を、JSON レイアウト DSL を使用して実現します（ロック画面、Dynamic Island、タイマー、共有 App Group 内の画像など）。Apple の App Intents、Siri フレーズ、ショートカットアプリ、Spotlight インデックス、または保留中の App Intent キューは実装していません。
ウィジェットのホーム画面表示、SVG テンプレート、または LiveActivityIntent テンプレートのイベントログに紐付いたボタンについては、 @capgo/capacitor-widget-kit を単独で、あるいはこのプラグインと併用してください。Siri フレーズ、Spotlight、および JavaScript での保留中の App Intent キューについては、 @capgo/capacitor-app-intents.
詳細は Siri、ショートカット、ウィジェット Capgo プラグインがシステムの統合機能にどのように対応しているかについて。
まずはこちらから areActivitiesSupported() および以下に示すその他のコアメソッド。
プラットフォーム対応
「プラットフォーム対応」という見出しのセクション| プラットフォーム | サポート | 備考 |
|---|---|---|
| iOSと | はい | ネイティブ |
| Android | はい | ネイティブ |
| Web | いいえ | Capacitor.getPlatform() でガード |
コア機能
「コア機能」セクションareActivitiesSupported- このデバイスが Live Activities に対応しているか確認します。iOS 16.1 以上かつデバイスのサポートが必要です。startActivity- 指定したレイアウトとデータで新しい Live Activity を開始します。updateActivity- 既存の Live Activity を新しいデータで更新します。endActivity- Live Activity を終了します。
公開 API
「Public API」セクション| メソッド | 説明 |
|---|---|
areActivitiesSupported | このデバイスが Live Activities に対応しているか確認します。iOS 16.1 以上かつデバイスのサポートが必要です。 |
startActivity | 指定したレイアウトとデータで新しい Live Activity を開始します。 |
updateActivity | 既存の Live Activity を新しいデータで更新します。 |
endActivity | Live Activityを終了します。 |
getAllActivities | 現在アクティブなすべてのLive Activityを取得します。 |
saveImage | Live Activityで使用するために、画像を共有App Groupコンテナに保存します。ウィジェット拡張機能からアクセスするには、画像を共有コンテナに保存する必要があります。 |
removeImage | 共有コンテナから保存済みの画像を削除します。 |
listImages | 共有コンテナ内の保存済み画像をすべて一覧表示します。 |
cleanupImages | 共有コンテナから保存済み画像をすべて削除します。 |
getPluginVersion | ネイティブの Capacitor プラグインのバージョンを取得します。 |
startTimerSequence | ワークアウトやスポーツ用のタイマーシーケンスを開始します。iOSではLive ActivityとDynamic Islandに表示され、Androidではタイマー付きのフォアグラウンド通知として表示されます。 |
pauseTimerSequence | タイマーシーケンスを一時停止します。 |
resumeTimerSequence | 一時停止中のタイマーシーケンスを再開します。 |
stopTimerSequence | タイマーシーケンスを停止して閉じます。 |
skipTimerStep | シーケンスの次のステップへスキップします。 |
previousTimerStep | シーケンスの前のステップに戻ります。 |
getTimerState | タイマーシーケンスの現在の状態を取得します。 |
addListener | タイマーシーケンスのイベントリスナーを追加します。イベントには stepChange、complete、tick、paused、resumed、stopped、loopComplete が含まれます。 |
Source of Truth
「Source Of Truth」セクションこのリファレンスは以下から同期されています： src/definitions.ts における capacitor-live-activities.
@capgo/capacitor-live-activities から先に進む
「@capgo/capacitor-live-activities から先に進む」というタイトルのセクション使用している場合 @capgo/capacitor-live-activities ネイティブメディアとインターフェースの挙動を計画するには、次と連携させてください @capgo/capacitor-live-activities の使用 @capgo/capacitor-live-activities の使用におけるネイティブ機能については、 @capgo/capacitor-video-playerの使用方法 @capgo/capacitor-video-player の使い方におけるネイティブ機能については、 @capgo/capacitor-video-player @capgo/capacitor-video-player の実装詳細については、 @capgo/capacitor-native-navigation の活用 @capgo/capacitor-native-navigation の使用によるネイティブ機能については、 @capgo/capacitor-native-navigation @capgo/capacitor-native-navigation. の実装詳細については
