跳过主要内容
返回插件
@capgo/capacitor-watch
教程
@capgo/capacitor-watch

手表

苹果手表与iPhone和watchOS应用之间的双向消息传递

指南

Watch教程

在设备上测试

Download the Capgo app, then scan the QR code.

Watch plugin preview QR code

使用 @capgo/capacitor-watch

Apple Watch 通信插件,适用于 Capacitor。该插件提供了 iPhone 和 Apple Watch 之间的双向消息传递,使用 WatchConnectivity。

安装

bun add @capgo/capacitor-watch
bunx cap sync

此插件暴露的内容

  • sendMessage - 向 Apple Watch 发送交互式消息。Apple Watch 必须可达,否则此操作将失败。使用此功能进行实时、交互式通信。
  • updateApplicationContext - 更新与 Apple Watch 共享的应用程序上下文。仅保留最新的上下文 - 这将覆盖任何之前的上下文。使用此功能同步应用程序状态,Apple Watch 需要显示这些状态。
  • 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

更新应用程序与手表共享的上下文。仅保留最新的上下文 - 这会覆盖任何以前的上下文。使用此功能同步应用程序状态,以便手表可以显示。

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

全局参考

继续使用@capgo/capacitor-watch

如果您正在使用 使用@capgo/capacitor-watch 规划原生插件工作时,连接它与 @capgo/capacitor-watch 为 @capgo/capacitor-watch 的实现细节, 开始使用 为 Getting Started 的实现细节, Capgo 插件目录 为 Capgo 插件目录中的产品工作流, Capacitor 由 Capgo 提供的插件 为 Capacitor 插件由 Capgo 提供的实现细节,并且 添加或更新插件 为添加或更新插件的实现细节。