跳到主要内容
版本：v5

@capacitor/watch

CapacitorLABS - 此项目为实验性质。不提供官方支持，如有需要请提交问题报告。

Capacitor Watch 插件允许您在网页代码中定义手表界面，并在配对的手表上显示。

目前仅支持 iOS 平台。本指南假设您已为 Capacitor 项目添加了 iOS 支持。

请注意：所有功能仅适用于真实的 Apple Watch 设备。模拟器无法实现真机上的应用与手表通信。

安装​

第一步

将 watch 插件添加到您的 Capacitor 项目中，然后打开 Xcode 工程：

npm install @capacitor/watch
npx cap sync
npx cap open ios

第二步

添加应用能力：

添加 'Background Modes' 和 'Push Notification' 能力。在 Background Modes 选项中勾选 'Background Fetch'、'Remote Notifications' 和 'Background Processing'。最终您的应用目标应如下图所示：

第三步

打开 AppDelegate.swift 文件，在顶部添加 import WatchConnectivity 和 import CapactiorWatch，然后在 application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) 方法中添加以下代码：

assert(WCSession.isSupported(), "This sample requires Watch Connectivity support!")
WCSession.default.delegate = CapWatchSessionDelegate.shared
WCSession.default.activate()

第四步

在 Xcode 中选择 File -> New -> Target，然后选择 watchOS 标签下的 'App'：

点击 'Next' 后按如下方式填写选项：

注意关键点：'Bundle Identifier' 必须为 [您的应用包ID].watchapp 才能使手表与应用配对。界面必须选择 SwiftUI，语言选择 Swift。项目名称应为 App。

第五步

我们将添加使 Capacitor Watch 在手表应用中工作的代码。

如果您使用 Xcode 15 Beta 4 或更高版本，需要从 node_modules 添加 Capacitor Watch Swift 包：

首先进入项目包依赖：

然后选择 'Add Local'：

导航到 node_modules/@capacitor/watch/CapWatch-Watch-SPM 文件夹并点击 'Add Package'：

在右侧列中选择您的手表应用作为目标，然后点击 'Add Package'：

完成后，您的包依赖应如下图所示：

对于 Xcode 14 用户，请访问 https://github.com/ionic-team/CapacitorWatch/tree/main/packages/iOS-capWatch-watch/Sources/iOS-capWatch-watch 并将所有文件复制到您的手表项目中，确保目标选中了您的手表应用。应如下图所示：

第六步

打开手表应用的 'Main' 文件（通常为 watchappApp.swift）。在 @main 声明前添加 import WatchConnectivity，然后将 ContentView() 替换为：

CapWatchContentView()
    .onAppear {
        assert(WCSession.isSupported(), "This sample requires Watch Connectivity support!")
        WCSession.default.delegate = WatchViewModel.shared
        WCSession.default.activate()
    }

完成后的文件应如下所示：

第七步

为手表应用目标添加 'Background Modes' 能力，并启用 'Remote Notifications'：

现在您应该可以开始开发 Capacitor Watch 应用了！

开发流程​

您可以像普通 Capacitor 应用一样开发 iOS 应用，但要在手表上运行需要更改 Xcode 中的目标和目标设备。可以通过 Xcode 顶部中间位置的 'Target Dropdown' 进行更改：

该栏的右侧可选择目标设备或模拟器。您需要选择与手机配对的手表，然后点击 'Run' 按钮或使用 'cmd+r' 运行快捷键。

手表和手机应用同步可能会遇到一些问题。有时 Xcode 控制台会报错说配套应用不存在。此时最佳解决方案是在两台设备上重新构建并重新安装应用。

构建手表界面并发送到手表​

您需要使用长字符串定义手表界面。组件之间用换行符分隔。目前该插件仅支持垂直滚动视图中的文本(Text)或按钮(Button)组件。

定义好界面后，可以使用 updateWatchUI() 方法将其发送到手表：

async uploadMyWatchUI() {
    const watchUI =
        `Text("Capacitor WATCH")
         Button("Add One", "inc")`;

    await Watch.updateWatchUI({"watchUI": watchUI});
}

将生成如下界面：

与手表通信​

这篇文章很好地总结了原生方法及其含义：https://alexanderweiss.dev/blog/2023-01-18-three-ways-to-communicate-via-watchconnectivity

在手机端，您可以使用 Capacitor Background Runner 插件(https://github.com/ionic-team/capacitor-background-runner)实现这些方法。目前 watch 插件主要处理 didReceiveUserInfo 方法，您可以在应用处于后台时通过以下 runner.js 代码接收手表事件：

addEventListener('WatchConnectivity_didReceiveUserInfo', (args) => {
  console.log(args.message.jsCommand);
});

您也可以实现 runCommand 事件监听器进行前台处理：

Watch.addListener('runCommand', (data: { command: string }) => {
  console.log('手机端收到命令 - ' + data.command);
});

命令是手表界面 Button() 定义中的第二个参数。可以是任意字符串。

更新手表数据​

您可以通过 $ 变量将变量添加到 Text() 元素中，并使用 updateWatchData 命令更新：

Text("显示我的 $number")

此示例将在执行时更新 $number：

var stateData = {
  number: 0,
};

async function counterIncrement() {
  stateData.counter++;
  await Watch.updateWatchData({ data: convertValuesOfObjectToStringValues(stateData) });
}

手表上的持久化

Capacitor Watch 会保留您通过 updateWatchUI() 发送的最后界面。来自 updateWatchData() 的状态不会被保留。

安装​

npm install @capacitor/watch
npx cap sync

API​

addListener('runCommand', ...)​

addListener(eventName: 'runCommand', listenerFunc: (data: { command: string; }) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

监听来自手表的命令

参数类型
eventName'runCommand'
listenerFunc(data: { command: string; }) => void

返回: 

Promise<PluginListenerHandle> & PluginListenerHandle

updateWatchUI(...)​

updateWatchUI(options: { watchUI: string; }) => Promise<void>

用 watchUI 替换当前的手表界面

参数类型
options{ watchUI: string; }

updateWatchData(...)​

updateWatchData(options: { data: { [key: string]: string; }; }) => Promise<void>

更新手表的状态数据

参数类型
options{ data: { [key: string]: string; }; }

Interfaces​

PluginListenerHandle​

属性类型
remove() => Promise<void>

Contents

编辑此页