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

监视

Apple Watch与iPhone和watchOS应用之间的双向消息传递

指南

__CAPGO_KEEP_0__上的教程

使用@capgo/capacitor-watch

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

安装

bun add @capgo/capacitor-watch
bunx cap sync

此插件暴露了什么

  • sendMessage - 向手表发送一个交互式消息。手表必须可达,否则此操作将失败。使用此功能进行实时、交互式通信。
  • updateApplicationContext - 更新与手表共享的应用程序上下文。仅保留最新的上下文 - 这会覆盖任何之前的上下文。使用此功能同步应用程序状态以供手表显示。
  • transferUserInfo - 将用户信息传输到手表。传输会被排队并按顺序传递,即使手表当前不可达。使用此功能传输重要数据以确保可靠传递。
  • replyToMessage - 回复来自手表的消息,该消息要求回复。使用此功能回复messageReceivedWithReply事件的消息。

示例使用

sendMessage

向手表发送一个交互式消息。手表必须可达才能成功。使用此功能进行紧急、交互式通信。

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 中的实现细节, 开始使用 关于在开始使用中实现细节, Capgo 插件目录 关于在 Capgo 插件目录中的产品工作流程, Capacitor 由 Capgo 提供的插件 关于在 Capacitor 由 Capgo 提供的插件中实现细节, 添加或更新插件 关于在添加或更新插件中实现细节。