ガイド
Capacitor で Watch を使う方法
@capgo/capacitor-watch の使用方法
Capacitor 用の Apple Watch 通信プラグイン。WatchConnectivity を使用して iPhone と Apple Watch 間の双方向メッセージングを提供します。
インストール
bun add @capgo/capacitor-watch
bunx cap sync
このプラグインで利用可能な機能
sendMessage- ウォッチにインタラクティブなメッセージを送信します。成功するにはウォッチが通信可能な状態である必要があります。即時性が求められる対話的な通信に使用してください。updateApplicationContext- ウォッチと共有するアプリケーションのコンテキストを更新します。最新のコンテキストのみが保持され、以前のコンテキストは上書きされます。ウォッチに表示させる必要があるアプリの状態を同期する際に使用してください。transferUserInfo- ユーザー情報をウォッチに転送します。転送はキューに格納され、ウォッチがオフラインの状態でも順番に配信されます。確実に届ける必要がある重要なデータの転送に使用してください。replyToMessage- 返信を求めてきたウォッチからのメッセージに対して返信します。messageReceivedWithReply イベントへのレスポンスとして使用してください。
使用例
sendMessage
ウォッチにインタラクティブなメッセージを送信します。成功するにはウォッチが通信可能な状態である必要があります。即時性が求められる対話的な通信に使用してください。
import { CapgoWatch } from '@capgo/capacitor-watch';
await CapgoWatch.sendMessage({
data: { action: 'refresh', timestamp: Date.now() }
});
updateApplicationContext
watchと共有するアプリケーションコンテキストを更新します。最新のコンテキストのみが保持され、以前のコンテキストは上書きされます。watchに表示する必要があるアプリ状態の同期に使用します。
import { CapgoWatch } from '@capgo/capacitor-watch';
await CapgoWatch.updateApplicationContext({
context: { theme: 'dark', lastSync: Date.now() }
});
transferUserInfo
ユーザー情報をwatchに転送します。転送はキューに格納され、watchが現在到達できなくても順序どおりに配信されます。確実に届ける必要がある重要なデータに使用してください。
import { CapgoWatch } from '@capgo/capacitor-watch';
await CapgoWatch.transferUserInfo({
userInfo: { recordId: '123', action: 'created' }
});
replyToMessage
返信を要求したwatchからのメッセージに返信します。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 の使用方法から続きを読む
使用している場合 @capgo/capacitor-watch の使用方法 ネイティブプラグインの作業を計画するには、次と連携してください： @capgo/capacitor-watch @capgo/capacitor-watch の実装詳細については、 スタートガイド スタートガイドの実装詳細については、 Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor Plugins の実装詳細、および プラグインの追加または更新 プラグインの追加または更新に関する実装詳細についてはこちら。