@capgo/capacitor-live-activities

概要

Capacitor iOSライブアクティビティ用のインターフェイス

基本機能

• areActivitiesSupported - このデバイスでライブアクティビティがサポートされているかどうかを確認します。iOS 16.1+ とデバイスのサポートが必要です。
• startActivity - 指定されたレイアウトとデータで新しいライブアクティビティを開始します。
• updateActivity - 既存のライブアクティビティに新しいデータで更新します。
• endActivity - ライブアクティビティを終了します。

Public API

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

真実の源

このリファレンスは src/definitions.ts で capacitor-ライブ アクティビティ.