ガイド
How to use Watch in Capacitor
Apple Watchを使用するための@capgo/capacitor-watch
Capacitor用のApple Watch通信プラグイン。iPhoneとApple Watch間でWatchConnectivityを使用したバイディレクショナルメッセージングを提供します。
インストール
bun add @capgo/capacitor-watch
bunx cap sync
このプラグインが公開するもの
sendMessage- Apple Watchにインタラクティブなメッセージを送信します。Apple Watchが到達可能な場合にのみ成功します。このメッセージは時限のあるインタラクティブなコミュニケーションに使用します。updateApplicationContext- Apple Watchと共有するアプリケーションコンテキストを更新します。最新のコンテキストのみが保持され、以前のコンテキストは上書きされます。このアプリケーション状態をApple Watchが表示する必要がある場合に、syncingを使用します。transferUserInfo- Apple Watchにユーザー情報を転送します。転送はキュー化され、Apple Watchが現在到達可能でない場合でも、順序に従って配信されます。この重要なデータを信頼性の高い方法で配信する必要がある場合に使用します。replyToMessage- Apple Watchから返信するメッセージに返答します。このメッセージは、messageReceivedWithReplyイベントの返答に使用します。
使用例
sendMessage
Apple Watchにインタラクティブなメッセージを送信します。Apple Watchが到達可能な場合にのみ成功します。このメッセージは時限のあるインタラクティブなコミュニケーションに使用します。
import { CapgoWatch } from '@capgo/capacitor-watch';
await CapgoWatch.sendMessage({
data: { action: 'refresh', timestamp: Date.now() }
});
updateApplicationContext
Apple Watchと共有するアプリケーションコンテキストを更新します。最新のコンテキストのみが保持され、以前のコンテキストは上書きされます。このアプリケーション状態をApple Watchが表示する必要がある場合に、syncingを使用します。
import { CapgoWatch } from '@capgo/capacitor-watch';
await CapgoWatch.updateApplicationContext({
context: { theme: 'dark', lastSync: Date.now() }
});
transferUserInfo
ウォッチにユーザー情報を転送する。転送はキューに並べられ、ウォッチが現在アクセスできない場合でも順番に配信されます。重要なデータを信頼性の高い方法で配信する必要がある場合に使用してください。
import { CapgoWatch } from '@capgo/capacitor-watch';
await CapgoWatch.transferUserInfo({
userInfo: { recordId: '123', action: 'created' }
});
replyToMessage
ウォッチから返信する。メッセージを受信した際にmessageReceivedWithReplyイベントが発生した場合に使用してください。
import { CapgoWatch } from '@capgo/capacitor-watch';
CapgoWatch.addListener('messageReceivedWithReply', async (event) => {
const result = await processRequest(event.message);
await CapgoWatch.replyToMessage({
callbackId: event.callbackId,
data: { result }
});
});
フルリファレンス
- GitHub: https://github.com/Cap-go/capacitor-watch/
- ドキュメント: /docs/plugins/watch/
@capgo/capacitor-watch
Capacitor Watchを使用している場合 Using @capgo/capacitor-watch Capacitor Watchを使用している場合 @capgo/capacitor-ウォッチ @capgo/capacitorウォッチの実装詳細 スタートガイド スタートガイドの実装詳細について Capgo プラグインディレクトリ Capgo プラグインディレクトリの製品ワークフローについて Capacitor Capgo プラグイン Capacitor Capgo プラグインの実装詳細について プラグインの追加または更新 プラグインの追加または更新の実装詳細について