版本：v5

@capacitor/watch

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

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

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

另请注意：所有这些功能仅适用于实际的 Apple Watch。模拟器无法像真实设备那样实现应用与手表之间的通信。

安装

步骤 1

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

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

步骤 2

添加功能：

添加“Background Modes”和“Push Notification”功能。然后在 Background Modes 选项中，选择“Background Fetch”、“Remote Notifications”和“Background Processing”。您的应用目标应如下所示：

步骤 3

打开 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()

步骤 4

在 Xcode 中选择 File -> New -> Target，然后选择 watchOS 标签页和“App”：

点击“Next”，然后按如下方式填写选项：

此对话框可能有些令人困惑，关键点在于您的“Bundle Identifier”必须是 [您的应用包ID].watchapp，才能使手表与应用配对正常工作。您还必须为界面选择 SwiftUI，为语言选择 Swift。项目应为 App。

步骤 5

我们将添加使 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 并将所有文件复制到您的手表项目中，并确保所选目标是您的手表应用。应如下所示：

步骤 6

然后打开手表应用的“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()
    }

完成的文件应如下所示：

步骤 7

为手表应用目标添加“Background Modes”功能，并启用“Remote Notifications”：

现在您应该已经准备好开发 Capacitor Watch 应用了！

开发工作流程

您仍然可以像开发普通 Capacitor 应用一样开发 iOS 应用，但要在手表上运行内容，您需要在 Xcode 中更改目标和目标设备。您可以使用 Xcode 中心顶部附近的“目标下拉菜单”进行更改：

此栏的右半部分让您选择目标设备或模拟器。您需要选择与手机配对的手表，然后点击“Run”按钮或使用“cmd+r”运行快捷键。

在同步手表和手机应用时可能会遇到一些挑战。有时 Xcode 控制台会报错，抱怨配套应用不存在。这种情况下最好的解决方案是在两个设备上重新构建并重新安装应用。

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

您将使用长字符串来定义手表界面。换行符用于分隔组件。目前此插件仅支持垂直滚动视图，其中包含文本或按钮组件。

定义好界面后，您可以使用 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 后台运行插件（https://github.com/ionic-team/capacitor-background-runner）来实现这些方法。目前手表插件主要处理 didReceiveUserInfo 方法，您可以在 runner.js 中使用以下代码在应用处于后台时接收来自手表的事件：

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

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

Watch.addListener("runCommand", (data: {command: string}) => {
  console.log("PHONE got command - " + data.command);
})

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

更新手表数据

您可以通过使用 $ 变量和 updateWatchData 命令来更新 Text() 元素中的变量：

Text("显示我的 $number")

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

var stateData = {
  number: 0
}

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

手表上的数据持久化

Capacitor Watch 会持久化您通过 updateWatchUI() 发送的最后一个 UI。通过 updateWatchData() 更新的状态数据不会被保留。

安装

npm install @capacitor/watch
npx cap sync

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

接口

PluginListenerHandle

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

安装​

开发工作流程​

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

更新手表数据​

手表上的数据持久化

安装​

API​

addListener('runCommand', ...)​

updateWatchUI(...)​

updateWatchData(...)​

接口​

PluginListenerHandle​

Contents

安装