跳到主要内容
版本:v7

保存插件调用

在大多数情况下,插件方法被调用来执行一个任务,然后可以立即完成。但有些情况下,你需要保持插件调用的可用性,以便稍后访问。

概述

你可能需要插件调用(iOS 上的 CAPPluginCall 或 Android 上的 PluginCall)在插件方法之外持久化,有两个原因:

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

这两个原因可能有重叠,但有一个重要区别。具体来说,就是调用是否需要返回多次数据。Capacitor bridge 记录从 JavaScript 到原生环境的每个调用,以便在插件返回结果时将结果匹配到正确的代码,而默认行为是在 resolve()reject() 被调用一次后清除此记录。但是,如果你的方法是会多次调用 resolve() 的回调,则涉及额外的步骤。有关如何声明回调的更多信息,请参见此处。


为单次完成保存调用

如果你需要保存一个调用以供将来完成一次,你有两个选择。一个选择是简单地将其保存在实例变量中。第二个选择是使用 bridge 的方法集来保存它,然后通过 callbackId 稍后检索它。调用 resolve()reject() 后,你可以丢弃 call 对象,因为它将不再相关(如果使用了 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)

为多次完成保存调用

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

要标记这样的调用,请设置其 keepAlive 属性(在 3.0 之前称为 isSaved,但已重命名以使行为更清晰)。

iOS

call.keepAlive = true

Android

call.setKeepAlive(true);

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