@capgo/capacitor-watch

概要

Capacitor用のApple Watch通信プラグイン。iPhoneとApple Watch間のWatchConnectivityを使用した双方向メッセージングを提供します。

基本機能

• sendMessage - 時計にインタラクティブなメッセージを送信します。時計が受信可能な状態である必要があります。この機能を使用して、タイムセンシティブなインタラクティブなコミュニケーションを行うことができます。
• updateApplicationContext - 時計と共有しているアプリケーション コンテキストを更新します。最新のコンテキストのみが保持されるため、以前のコンテキストを上書きします。この機能を使用して、アプリケーション ステートを同期するために、時計が表示する必要があるものをsyncすることができます。
• transferUserInfo - ユーザー情報を時計に転送します。転送はキュー化され、時計が現在受信可能な状態でない場合でも、順序に従って転送されます。この機能を使用して、信頼性が高く重要なデータを確実に転送することができます。
• replyToMessage - 時計からメッセージが返信を要求した場合に、返信するメッセージを送信します。この機能を使用して、messageReceivedWithReply イベントの応答として返信することができます。

パブリック API

メソッド	説明
sendMessage	時計にインタラクティブなメッセージを送信します。時計が受信可能な状態である必要があります。この機能を使用して、タイムセンシティブなインタラクティブなコミュニケーションを行うことができます。
updateApplicationContext	時計と共有しているアプリケーション コンテキストを更新します。最新のコンテキストのみが保持されるため、以前のコンテキストを上書きします。この機能を使用して、アプリケーション ステートを同期するために、時計が表示する必要があるものをsyncすることができます。
transferUserInfo	ユーザー情報を時計に転送します。転送はキュー化され、時計が現在受信可能な状態でない場合でも、順序に従って転送されます。この機能を使用して、信頼性が高く重要なデータを確実に転送することができます。
replyToMessage	時計からメッセージが返信を要求した場合に、返信するメッセージを送信します。この機能を使用して、messageReceivedWithReply イベントの応答として返信することができます。
getInfo	時計の接続状態についての情報を取得します。
getPluginVersion	Capacitorのネイティブプラグインバージョンを取得します。
addListener	時計から受信したメッセージをリスンします。
addListener	時計から返信が必要なメッセージをリスンします。
addListener	時計からアプリケーションコンテキストの更新をリスンします。
addListener	時計からユーザー情報の転送をリスンします。
addListener	時計の接続状態の変更をリスンします。
addListener	時計のセッションの有効化状態の変更をリスンします。
removeAllListeners	このプラグインのすべてのリスナーを削除します。

真実の源

このリファレンスはGitHubからsyncされています src/definitions.ts in capacitor-watch.