跳到主要内容
版本:v4

保存插件调用

在大多数情况下,插件方法被调用执行任务后可以立即完成。但有些情况下,您需要保持插件调用可用,以便后续访问。

概述

您可能需要让插件调用(iOS 中的 CAPPluginCall 或 Android 中的 PluginCall)在插件方法之外持久存在的两个原因是:

  1. 执行异步操作,例如网络请求。
  2. 向 JavaScript 环境提供重复更新,例如流式传输实时地理位置数据。

这两个原因可能重叠,但有一个重要区别:即调用是否需要多次返回数据。Capacitor 桥接器会记录每个从 JavaScript 到原生的调用,以便在插件返回结果时将其匹配到正确的代码,默认行为是在调用一次 resolve()reject() 后清除这些记录。但如果您的方法是需要多次 resolve() 的回调,则需要额外步骤。关于如何声明回调的更多信息可在此处查看


保存单次完成的调用

如果您需要保存一个调用以便未来完成一次,有两个选项:一是简单地将其保存在实例变量中;二是使用桥接器的方法集保存它,然后通过 callbackId 稍后检索。调用 resolve()reject() 后,您可以丢弃调用对象,因为它不再相关(如果使用了 saveCall(),别忘了调用 releaseCall())。

iOS

func saveCall(_ call: CAPPluginCall)
func savedCall(withID: String) -> CAPPluginCall?
func releaseCall(_ call: CAPPluginCall)
func releaseCall(withID: String)

Android

void saveCall(PluginCall call)
PluginCall getSavedCall(String callbackId)
void releaseCall(PluginCall call)
void releaseCall(String callbackId)

保存多次完成的调用

保存一个调用以便未来多次完成意味着两件事:保存原生调用对象本身(如上所述),并告诉桥接器保留其记录,以便可以重复调用 resolve()reject()

要通过这种方式标记调用,请设置其 keepAlive 属性(在版本 3 之前称为 isSaved,但已重命名以使行为更清晰)。

iOS

call.keepAlive = true

Android

call.setKeepAlive(true);

如果 keepAlive 为 true,则可以按需多次调用 resolve(),结果将按预期返回。将此标志设置为 true 还意味着桥接器会在您的方法返回后自动为您调用 saveCall()