@capgo/capacitor-live-activities

概要

Capacitor iOSライブアクティビティ用プラグインのインターフェイスです。

基本機能

• areActivitiesSupported iOS 16.1以上とデバイスのサポートが必要です。-新しいライブアクティビティを指定されたレイアウトとデータで開始します。-既存のライブアクティビティを新しいデータで更新します。
• startActivity セクション「基本機能」
• updateActivity セクション「基本機能」
• endActivity - 活動を終了します。

パブリック API

メソッド	説明
areActivitiesSupported	このデバイスでライブアクティビティがサポートされているかどうかを確認します。iOS 16.1+ とデバイスのサポートが必要です。
startActivity	指定されたレイアウトとデータで新しいライブアクティビティを開始します。
updateActivity	既存のライブアクティビティに新しいデータを更新します。
endActivity	ライブアクティビティを終了します。
getAllActivities	現在アクティブなすべてのライブアクティビティを取得します。
saveImage	ライブアクティビティ用のウィジェット拡張で使用できるようにするために、共有アプリ グループ コンテナに画像を保存します。画像はウィジェット拡張で使用できるように共有コンテナに保存する必要があります。
removeImage	共有コンテナから保存された画像を削除します。
listImages	共有コンテナ内の保存された画像をすべてリストします。
cleanupImages	共有コンテナ内の保存された画像をすべて削除します。
getPluginVersion	ネイティブ Capacitor プラグインのバージョンを取得します。
startTimerSequence	トレーニング/スポーツ用のタイマーシーケンスを開始します。iOSではLive Activityとダイナミックアイランドに表示され、Androidではタイマーとしてフォアグラウンド通知が表示されます。
pauseTimerSequence	タイマーシーケンスを一時停止します。
resumeTimerSequence	一時停止したタイマーシーケンスを再開します。
stopTimerSequence	タイマーシーケンスを停止し、閉じます。
skipTimerStep	シーケンスの次のステップに進みます。
previousTimerStep	シーケンスの前のステップに戻ります。
getTimerState	タイマーシーケンスの現在の状態を取得します。
addListener	タイマーシーケンスのイベントにリスナーを追加します。イベントには、ステップ変更、完了、チック、一時停止、再開、停止、ループ完了が含まれます。

真実の源

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