跳到主要内容
版本：v3

Capacitor iOS API

Capacitor iOS 是驱动 Capacitor 应用在 iOS 上运行的原生运行时。

Bridge​

iOS bridge 是 Capacitor iOS 库的核心。bridge 上提供了多个属性和方法，用于提供信息或改变行为。

当使用 Capacitor 注册时，插件持有 bridge 的弱引用：

self.bridge?

如果你的方法需要 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://（设备上文件的完整 URL）

portablePath(...)​

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

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

传递数据​

关于如何处理在环境之间传递的数据的说明可以在这里找到。

保存 CAPPluginCall​

关于持久化插件调用以用于异步或重复操作的说明可以在这里找到。

Contents

编辑此页