使用JSAPI
初始化
使用 H5 容器通用 JS API 前,需要完成的基本初始化操作。
前置条件
若要通过组件初始化,必须先完成 SDK 集成,详情请参见 集成SDK。
引入头文件
#import "TMFJSBridge.h"
#import "TMFJSAPIs.h"
初始化步骤
通用 JS API 的初始化,强依赖于 TMFJSBridge
组件的 TMFJSBridgeConfiguration
模块,使用 JS API,需要使用 -[TMFJSBridgeConfiguration registerFunction:withInvocationClass:]
来完成注册:
+ (instancetype)sharedConfiguration;
- (BOOL)registerFunction:(NSString *)function withInvocationClass:(Class)invocationClass;
初始化示例
下面是初始化通用 JS API 中 基础信息能力的示例:
TMFJSBridgeConfiguration *configuration = [TMFJSBridgeConfiguration sharedConfiguration];
// AppInfo
// 获取版本号
[configuration registerFunction:@"getVersion" withInvocationClass:[TMFJSBridgeInvocation_getVersion class]];
// 获取 Build 号
[configuration registerFunction:@"getBuild" withInvocationClass:[TMFJSBridgeInvocation_getBuild class]];
// 获取 GUID
[configuration registerFunction:@"getGUID" withInvocationClass:[TMFJSBridgeInvocation_getGUID class]];
// 设置页面信息
[configuration registerFunction:@"setPageInfo" withInvocationClass:[TMFJSBridgeInvocation_setPageInfo class]];
// 设置账号
[configuration registerFunction:@"setCustomUserInfo" withInvocationClass:[TMFJSBridgeInvocation_setCustomUserInfo class]];
API 使用
前提条件
若要使用 JSAPI,必须先完成组件初始化,详情请参见 初始化。
H5 调用本地能力
TMFJSBridge.invoke(apiName, {
param0 : param0, // any,参数 0
param1 : param1, // any,参数 1
// ...
paramN : paramN, // any,参数 n
}, function (res) {
console.log({
ret : res.ret, // integer,接入层错误码,有效值:0 表示成功,1 表示接入层失败,2 表示业务层失败,-1 表示取消(部分接口有取消操作)
errMsg : res.errMsg, // string,接入层错误详细信息
});
});
入参 | 类型 | 描述 | 必选 | 默认值 |
---|---|---|---|---|
param0 - paramN | any | 传递参数 | Y / N | / |
callback | function | 返回值回调函数 | Y | / |
出参 | 类型 | 描述 |
---|---|---|
ret | integer | 接入层错误码 0: 成功 1: 接入层失败 2: 业务层失败 -1: 取消(部分接口有取消操作) |
errMsg | string | 接入层错误详情信息 |
H5 监听本地事件
document.addEventListener(eventName, function (e) {
var res = e.tmf;
console.log({
param0 : res.param0, // any,参数 0
param1 : res.param1, // any,参数 1
// ...
paramN : res.paramN, // any,参数 n
});
}, false);
参数 | 类型 | 描述 | 必选 | 默认值 |
---|---|---|---|---|
eventName | string | 事件名 | Y | / |
e | object | 返回值 | Y | / |