メインコンテンツにジャンプ
プラグインに戻る
@capgo/capacitor-watch
チュートリアル
@capgo/capacitor-watch

ウォッチ

iPhoneとwatchOSアプリ間の bidirectional メッセージングによるApple Watchとの通信

ガイド

ウォッチのチュートリアル

デバイスでテスト

Download the Capgo app, then scan the QR code.

ウォッチ プラグイン プレビュー QR code

使用する @capgo/capacitor-watch

Apple Watch communication plugin for Capacitor. Provides bidirectional messaging between iPhone and Apple Watch using WatchConnectivity.

インストール

bun add @capgo/capacitor-watch
bunx cap sync

このプラグインが公開するもの

  • sendMessage - Apple Watch に対してインタラクティブなメッセージを送信します。ウォッチが利用可能な場合にのみ成功します。この機能は、タイムセンシティブなインタラクティブなコミュニケーションに使用します。
  • updateApplicationContext - Apple Watch に共有するアプリケーション コンテキストを更新します。最新のコンテキストのみが保持され、以前のコンテキストは上書きされます。この機能は、アプリケーション ステートをウォッチが表示する必要がある場合に使用します。
  • transferUserInfo - Apple Watch にユーザー情報を転送します。転送はキュー化され、ウォッチが利用可能でない場合でも順序に従って配信されます。この機能は、信頼性が高く重要なデータを転送する場合に使用します。
  • replyToMessage - Apple Watch から返信するメッセージに応答します。この機能は、messageReceivedWithReply イベントに応答する場合に使用します。

例の使用方法

sendMessage

Apple Watch に対してインタラクティブなメッセージを送信します。ウォッチが利用可能な場合にのみ成功します。この機能は、タイムセンシティブなインタラクティブなコミュニケーションに使用します。

import { CapgoWatch } from '@capgo/capacitor-watch';

await CapgoWatch.sendMessage({
  data: { action: 'refresh', timestamp: Date.now() }
});

updateApplicationContext

__CAPGO_KEEP_0__:

import { CapgoWatch } from '@capgo/capacitor-watch';

await CapgoWatch.updateApplicationContext({
  context: { theme: 'dark', lastSync: Date.now() }
});

transferUserInfo

__CAPGO_KEEP_0__の最新のアプリケーションコンテキストをアップデートします。最新のコンテキストのみが保持され、以前のコンテキストは上書きされます。この機能は、時計で表示する必要があるアプリの状態を同期するために使用します。

import { CapgoWatch } from '@capgo/capacitor-watch';

await CapgoWatch.transferUserInfo({
  userInfo: { recordId: '123', action: 'created' }
});

replyToMessage

__CAPGO_KEEP_0__のユーザー情報を時計に転送します。転送はキュー化され、時計が現在アクセスできない場合でも順番に送信されます。この機能は、信頼性が高く重要なデータを確実に送信するために使用します。

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 }
  });
});

時計から返信メッセージを受信した場合に返信する機能です。この機能は、messageReceivedWithReplyイベントの対応として使用します。

Keep going from Using @capgo/capacitor-watch

__CAPGO_KEEP_0__-watchを使用している場合 Using @capgo/capacitor-watch ネイティブプラグインの作業を計画するために@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-watchを使用している場合 @capgo/capacitor-watchを使用して接続する Capacitor-watch用の実装詳細については@capgo/capacitor-watchを参照してください。 Getting Started Capacitor-watch用の実装詳細についてはGetting Startedを参照してください。 Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, and プラグインの追加または更新 プラグインの追加または更新の実装詳細についてはプラグインの追加または更新を参照してください。