@capgo/capacitor-watch

概要

@capgo/capacitor-watch Capacitor のモバイルアプリと、連携するウォッチアプリを接続します：

• iOSと: WatchConnectivity watchOS ターゲット、およびオプションの CapgoWatchSDK.
• Android: Wear OS Data Layer (play-services-wearable) を使用し、同一の Android プロジェクト内に Wear OS モジュールを配置します。
• Web：ウォッチ間のメッセージングには対応していません。 getInfo() と getPluginVersion() 安全なデフォルト値で解決されます。メッセージングメソッドは拒否され、リスナーは登録されますがイベントは配信されません。

プラットフォーム対応

以下の機能は、各プラットフォームのネイティブ実装に準拠しています： CapgoWatchPlugin.swift と CapgoWatchPlugin.java.

機能	iOS (Apple Watch)	Android (Wear OS)	Web
sendMessage	はい。アクティブなセッションが必要です。 isReachable.	はい。以下で送信されます： /capgo/message 接続中のノードへ。Wear OSノードが未接続の場合は拒否されます。	いいえ
updateApplicationContext	はい。WatchConnectivity経由で最新の値のみ送信します。	Yes. DataItem at /capgo/context JSON形式で payload.	いいえ
transferUserInfo	はい。ユーザー情報の転送をキューに追加します。	Yes. DataItem at /capgo/userinfo/{uuid} JSON形式で payload.	いいえ
replyToMessage	はい。その後 messageReceivedWithReply.	はい。以下で送信されます /capgo/reply/{callbackId} watchノードへ（TTL 5分）。	いいえ
getInfo	はい。WatchConnectivityのペアリングと到達性。	はい。接続済みノードに加え、 capgo_watch watchアプリのインストール検知機能。	戻り値 isSupported: false
getPluginVersion	はい	はい	戻り値 { version: "web" }
messageReceived	はい	はい。受信中 /capgo/message.	登録のみ。Web上ではイベントなし
messageReceivedWithReply	はい	はい。受信中 /capgo/message/withreply.	登録のみ。Web上ではイベントなし
applicationContextReceived	はい	はい。受信中 /capgo/context DataItem。	登録のみ。Web上ではイベントなし
userInfoReceived	はい	はい。受信中 /capgo/userinfo/* (配信後、端末からアイテムが削除されます)。	登録のみ。Webではイベントが発生しません
reachabilityChanged	はい	Androidでは発行されません	登録のみ。Webではイベントが発生しません
activationStateChanged	はい	Androidでは発行されません	登録のみ。Webではイベントが発生しません

セットアップガイド

• watchOSアプリの作成 (Apple Watch + CapgoWatchSDK)
• Wear OSアプリの作成 (Wearモジュール + Data Layerパス)

コア機能

• sendMessage - ウォッチへインタラクティブなメッセージを送信します。成功するにはウォッチが通信可能な状態である必要があります。即時性が求められる対話的な通信に使用してください。
• updateApplicationContext - ウォッチと共有するアプリケーションのコンテキストを更新します。最新のコンテキストのみが保持され、以前のコンテキストは上書きされます。ウォッチに表示させる必要があるアプリの状態を同期する際に使用してください。
• transferUserInfo - ユーザー情報をウォッチに転送します。転送はキューに格納され、ウォッチが通信できない状態であっても順番に配信されます。確実に届ける必要がある重要なデータの転送に使用してください。
• replyToMessage - 返信を求めているウォッチからのメッセージに返信します。messageReceivedWithReply イベントへのレスポンスとして使用してください。

公開 API

メソッド	説明
sendMessage	ウォッチへインタラクティブなメッセージを送信します。成功するにはウォッチが通信可能な状態である必要があります。即時性が求められる対話的な通信に使用してください。
updateApplicationContext	watchと共有するアプリケーションコンテキストを更新します。最新のコンテキストのみが保持され、以前のコンテキストは上書きされます。watchに表示する必要があるアプリ状態の同期に使用します。
transferUserInfo	ユーザー情報をwatchに転送します。転送はキューに格納され、watchが現在到達できなくても順序どおりに配信されます。確実に届ける必要がある重要なデータに使用してください。
replyToMessage	返信を要求したwatchからのメッセージに返信します。messageReceivedWithReplyイベントへの応答として使用します。
getInfo	watchの接続ステータスに関する情報を取得します。
getPluginVersion	ネイティブの Capacitor プラグインのバージョンを取得します。
addListener	watchから受信するメッセージをリッスンします。
addListener	返信が必要なwatchからのメッセージをリッスンします。
addListener	watchからのアプリケーションコンテキスト更新をリッスンします。
addListener	watchからのユーザー情報転送をリッスンします。
addListener	watchの接続状態（reachability）の変化をリッスンします（iOSのみ）。
addListener	セッションのアクティベーション状態の変化をリッスンします（iOSのみ）。
removeAllListeners	このプラグインのすべてのリスナーを削除します。

Source of Truth

このリファレンスは以下から同期されています： src/definitions.ts における capacitor-watch.

@capgo/capacitor-watchの続き

使用している場合 @capgo/capacitor-watch 移行とエンタープライズ運用を計画するには、次と連携してください @capgo/capacitor-watch の使用方法 @capgo/capacitor-watch を使う際のネイティブ機能については、 Capgo エンタープライズ Capgo Enterprise のプロダクトワークフロー向けに、 Ionic Enterprise プラグインの代替案 Ionic Enterprise Plugin Alternatives のプロダクトワークフロー向けに、 Capgo の代替案 Capgo Alternatives のプロダクトワークフロー向け、および Capgo コンサルティング Capgo Consulting のプロダクトワークフロー向けに。