方法类型

开发插件时，可以使用三种不同类型的方法签名。它们都是异步且基于 Promise 的。

让我们考虑一个包含所有三种类型的插件定义：

export type CallbackID = string;

export interface MyData {
  data: string;
}

export type MyPluginCallback = (message: MyData | null, err?: any) => void;

export interface MyPlugin {
  method1(): Promise<void>;
  method2(): Promise<MyData>;
  method3(callback: MyPluginCallback): Promise<CallbackID>;
}

无返回值

method1() 是最简单的情况，预期不返回任何数据。您可以检查 Promise 是否出错，但当它 resolve 时，结果会被忽略。

对于 Android，您可以这样注解方法：

@PluginMethod(returnType = PluginMethod.RETURN_NONE)
public void method1(PluginCall call) {
}

对于 iOS，您可以在插件的 .m 文件中这样声明方法：

CAP_PLUGIN(MyPlugin, "MyPlugin",
           CAP_PLUGIN_METHOD(method1, CAPPluginReturnNone);
)

返回值

method2() 是最常见的情况：一个 resolve 并返回某个值的 Promise。

对于 Android，此方法类型是默认值，指定返回类型是可选的：

@PluginMethod()
public void method2(PluginCall call) {
}

对于 iOS，您可以在插件的 .m 文件中这样声明方法：

CAP_PLUGIN(MyPlugin, "MyPlugin",
           CAP_PLUGIN_METHOD(method2, CAPPluginReturnPromise);
)

回调

method3() 是最复杂的类型，但在实践中也是最不常见的。当您的插件需要重复返回数据时使用，例如通过地理定位 API 监控设备位置。

对于 Android，您可以这样注解方法：

@PluginMethod(returnType = PluginMethod.RETURN_CALLBACK)
public void method3(PluginCall call) {
}

对于 iOS，您可以在插件的 .m 文件中这样声明方法：

CAP_PLUGIN(MyPlugin, "MyPlugin",
           CAP_PLUGIN_METHOD(method3, CAPPluginReturnCallback);
)

回调方法接受一个函数，该函数将从原生代码中（可能多次）被调用，并返回一个会 resolve 为标识符的 Promise。

在原生端，实现回调意味着您需要保存调用，以便稍后可以调用它。如何处理此问题的具体细节在此讨论。