跳到主要内容
版本：v7

@capacitor/watch

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

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

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

请注意：所有功能仅适用于真实的 Apple Watch。模拟器不支持真实设备那样的应用与手表通信。

安装​

步骤 1

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

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

步骤 2

添加功能：

添加“后台模式”和“推送通知”功能。然后在后台模式选项中，选择“后台获取”、“远程通知”和“后台处理”。您的 App 目标应如下所示：

步骤 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 中选择文件 -> 新建 -> 目标，然后选择 watchOS 选项卡和“App”：

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

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

步骤 5

我们将把使 Capacitor Watch 正常工作的代码添加到手表应用中。

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

首先转到项目包依赖项

然后选择“添加本地”

然后导航到 node_modules/@capacitor/watch/CapWatch-Watch-SPM 文件夹，点击“添加包”

然后在右侧列中选择您的手表应用作为目标，点击“添加包”

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

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

步骤 6

然后打开手表应用的“主”文件，应为 watchappApp.swift。在 @main 语句上方添加 import WatchConnectivity 和 import iOS_capWatch_watch。然后将 ContentView() 这一行替换为以下内容：

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

import SwiftUI
import WatchConnectivity
import iOS_capWatch_watch

@main
struct watchddgg_Watch_AppApp: App {
    var body: some Scene {
        WindowGroup {
            CapWatchContentView()
                .onAppear {
                    assert(WCSession.isSupported(), "This sample requires Watch Connectivity support!")
                    WCSession.default.delegate = WatchViewModel.shared
                    WCSession.default.activate()
                }
        }
    }
}

步骤 7

为手表应用目标添加“后台模式”功能，并启用“远程通知”：

现在您应该可以开始为 Capacitor Watch 进行开发了！

开发工作流程​

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

此栏的右半部分允许您选择目标设备或模拟器。您需要选择与手机配对的手表，然后点击“运行”按钮或使用“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 后台运行插件 (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("手机收到命令 - " + data.command);
})

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

更新手表数据​

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

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

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

接口​

PluginListenerHandle​

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

Contents

编辑此页