# 自定义API管理
如果小程序里需要调用一些宿主 App 提供的能力,而 FinClip 小程序 SDK 未实现或无法实现时,就可以通过注册自定义 API 来实现,使得小程序里也能够调用 App 中注册的 API 了。
当然,要使用一些未实现或无法实现的组件时,也可以注册自定义组件。
注册自定义 API 分两个场景:
注册给原生小程序使用的自定义 API;
注册给小程序中 WebView 组件加载的 H5 使用的自定义 API。
# 1 注册自定义api
示例
MopSdk.registerExtensionApi(
// 自定义api名移
apiName,
(ret) => {
console.log('onCallback',ret)
//处理失败/成功处理,返回对应参数
MopSdk.onSuccess(ret.uuid,{
})
//失败
//MopSdk.onFail(ret.uuid,{})
}
);
参数
配置名称 | 类型 | 配置描述 |
---|---|---|
apiName | String | 自定义API名称 |
callback | Function | 自定义API回调函数 |
获取APP接收参数
配置名称 | 类型 | 配置描述 |
---|---|---|
uuid | String | 唯一标识 |
event | String | 事件名称 |
appId | String | 小程序ID |
params | Object | 小程序传参 |
# 2 取消注册自定义api (仅安卓)
示例
MopSdk.unRegisterExtensionApi(apiName);
参数
配置名称 | 类型 | 配置描述 |
---|---|---|
apiName | String | 自定义API名称 |
# 3 注册web-view自定义api
示例
MopSdk.registerWebExtentionApi(
// 自定义api名移
apiName,
(ret) => {
console.log('onCallback',ret)
//成功
MopSdk.onSuccess(ret.uuid,ret)
//失败
//MopSdk.onFail(ret.uuid,ret)
}
)
参数
配置名称 | 类型 | 配置描述 |
---|---|---|
apiName | String | 自定义API名称 |
callback | Function | 自定义API回调函数 |
# 4 取消注册web-view自定义api (仅安卓)
示例
MopSdk.unRegisterWebExtensionApi(apiName)
参数
配置名称 | 类型 | 配置描述 |
---|---|---|
apiName | String | 自定义API名称 |