跳到主要内容
版本：v4

Capacitor iOS API

Capacitor iOS 是支撑 Capacitor 应用在 iOS 平台运行的原生运行时环境。

桥接机制​

iOS 桥接器是 Capacitor iOS 库的核心组件。桥接器提供了多个属性和方法用于获取信息或改变行为。

当插件注册到 Capacitor 后，会持有桥接器的弱引用：

self.bridge?

如果方法需要使用桥接器，可以通过 guard 语句解包并提前返回：

guard let bridge = self.bridge else { return }

viewController​

var viewController: UIViewController? { get }

该属性包含 Capacitor 的主视图控制器，可用于在应用上方展示原生视图。

示例：

DispatchQueue.main.async {
  self.bridge?.viewController.present(ourCustomViewController, animated: true, completion: nil)
}

在 iPad 设备上可以展示弹出窗口：

self.setCenteredPopover(ourCustomViewController)
self.bridge.viewController.present(ourCustomViewController, animated: true, completion: nil)

config​

var config: InstanceConfiguration { get }

该属性包含 Capacitor 运行时已知的配置对象。

triggerJSEvent(...)​

func triggerJSEvent(eventName: String, target: String)
func triggerJSEvent(eventName: String, target: String, data: String)

在 JavaScript 的 EventTarget（如 window 或 document）上触发事件。推荐优先使用插件事件。

示例：

bridge.triggerJSEvent(eventName: "myCustomEvent", target: "window")
bridge.triggerJSEvent(eventName: "myCustomEvent", target: "document", data: "{ 'dataKey': 'dataValue' }")

注意：data 必须是序列化的 JSON 字符串值。

localURL(...)​

func localURL(fromWebURL webURL: URL?) -> URL?

将来自 Web 视图的 URL 转换为 iOS 原生的文件 URL。

Web 视图可能处理多种 URL 类型：

  • res://（访问 web 资源的快捷方案）
  • file://（指向本地设备的完整文件路径）

portablePath(...)​

func portablePath(fromLocalURL localURL: URL?) -> URL?

将 iOS 原生的文件 URL 转换为可在 Web 视图中加载的 URL。

数据传递​

关于跨环境数据传递的注意事项可参考此处。

保存 CAPPluginCall​

关于异步或重复操作中持久化插件调用的说明可查看此文档。

Contents

编辑此页