iOS JS交互方法规范

XMNJSBridge 方法说明

定义了JS,Native 通讯方法

github地址

通用属性

1. 属性说明

属性名称	属性类型	属性作用
actionList	Array	当前JS支持的action类型
dataTypeList	Array	当前JS支持通过getData,putData方法 获取的信息类型

2. actionList支持的action说明

action名称	action作用	对应extra说明
share	调起native分享方法,执行分享功能	{'title':'分享的标题','desc':'分享的描述','thumb':'分享的缩略图地址','link':'分享的链接地址'}
setTitle	设置当前页面的头部标题	{'title':'需要设置的标题'}
setBackButton	设置当前页面返回按钮	{'hidden':'1 , 0 是否隐藏','title':'按钮标题','image':'按钮图片','action':'按钮对应的功能'}
setRightButton	设置当前页面右侧按钮	{'hidden':'1 , 0 是否隐藏','title':'按钮标题','image':'按钮图片','action':'按钮对应的功能'}
takeImage	从原生通过拍照,相册 获取图片	{'count':'获取的图片数量','sizeType':'原图(origin),还是压缩图(compressed)','sourceType':'相机(camera),相册(album),或者两则都可以'}
previewImage	使用原生控件,进行图片预览	{'currentIndex':'当前预览的index','urls':'所有的图片数组'}
scanQRCode	使用原生空间,扫描二维码

3.dataTypeList 支持的数据类型说明

dataType名称	dataType作用	额外说明
userInfo	获取用户信息
deviceInfo	获取设备信息	osName,osVersion,deviceName,appVersion,bundleID
networkInfo	获取当前设备连接信息	2G,3G,4G,WIFI,无网络
locationInfo	当前定位信息	lat,lng,address,city

公共方法

1. getData

1.1 方法作用: 通过此方法,可以从native获取到对应datatype数据

1.2 参数说明 :

|参数名称|参数类型| 属性作用 | 参数是否必填 |
|-|-|-|
|datatype|String|获取数据的 数据类型| 是 |
|extra|Dict(Map)|传给native的额外参数|否 |
|callback|String| 回调方法,实现类型参考私有方法中的callback方法 | 否|

1.3 示例

1. JSBridge.getData('userinfo')
2. JSBridge.getData('userinfo','window.JSBridge.callback')
3. JSBridge.getData('userinfo',{'userID':'IDxxxxx'},'window.JSBridge.callback')

2. putData

2.1 方法作用: 通过此方法,将数据传送给native

2.2 参数说明 :

|参数名称|参数类型| 属性作用 | 参数是否必填 |
|-|-|-|
|datatype|String|获取数据的 数据类型| 是 |
|extra|Dict(Map)|传给native的额外参数| 是 |
|callback|String| 回调方法,实现类型参考私有方法中的callback方法 | 否|

2.3 示例

1. JSBridge.putData('userinfo',{'name':'newName'})
2. JSBridge.putData('userinfo',{'name':'newName'},'window.JSBridge.callback')

3. goWebView

3.1 方法作用: 通过此方法,可以打开新的webView页面

3.2 参数说明 :

|参数名称|参数类型| 属性作用 | 参数是否必填 |额外说明|
|-|-|-|
|url|String|新的网页页面地址| 是 | |
|pagetype|String|支持web(在同一个webView中打开页面),window(新打开一个webView加载url)两种类型, 默认使用window| 否 | 默认属性window模式|
|extra|Dict(Map)| 传入的额外参数 | 否|

3.3 示例

1. JSBridge.goWebView('http://www.baidu.com','window',{'name':'newName'})
2. JSBridge.goWebView('http://www.baidu.com','window',{'title':'window title'})

4. goNative

4.1 方法作用: 通过此方法,可以打开新的native原生页面

4.2 参数说明 :

|参数名称|参数类型| 属性作用 | 参数是否必填 | 额外说明|
|-|-|-|
|page|String|native页面对应的key| 是 | |
|extra|Dict(Map)| 传入的额外参数 | 否|

4.3 示例

1. JSBridge.goNative('info')
2. JSBridge.goNative('info',{'id':'IDxxxxx'})

5. goBack

5.1 方法作用: 通过此方法,返回上一个webView页面或者上一个原生页面

5.2 参数说明 :

|参数名称|参数类型| 属性作用 | 参数是否必填 |额外说明 |
|-|-|-| - |
|page|String|native页面对应的key(会检索native路由,返回key对应的原生页面,如果没有,则返回上一级页面),或者url(检测webView.url路由,如果存在则返回对应的url页面,否则返回上一级页面)| 否 | page不传默认返回上一级页面 |
|extra|Dict(Map)| 传入的额外参数 | 否| |

5.3 示例

1. JSBridge.goBack('info') -- 返回到用户信息页面,如果没进入过用户信息页面,则返回上一级页面
2. JSBridge.goBack('http://www.baidu.com') -- 如果webView打开过http://www.baidu.com页面,则重新返回到该页面,否则返回上一级页面

6. goLogin

6.1 方法作用: 通过此方法,打开登录页面

6.2 参数说明 :

|参数名称|参数类型| 属性作用 | 参数是否必填 |额外说明 |
|-|-|-| - |
|backUrl |String|登录完成后的回调URL,如果有次参数,则登录成功后会打开这个网址页面| 否 | 不传默认打开登录之前页面|
|extra|Dict(Map)| 传入的额外参数 | 否| |
|callBack|String|回调方法|否|需要注意此回调是在唤起login页面的地址实现回调|

6.3 示例

1. JSBridge.goLogin() -- 打开登录页面,进行登录
2. JSBridge.goLogin('http://www.baidu.com') -- 打开登录页面,用户进行登录,登录完成后打开http://www.baidu.com页面

7. doAction

7.1 方法作用: 执行某个动作,具体参考actionList说明

7.2 参数说明 :

|参数名称|参数类型| 属性作用 | 参数是否必填 |额外说明 |
|-|-|-| - |
|action |String|对应的动作类型key| 是 | |
|extra|Dict(Map)| 传入的额外参数 | 否| |
|callBack|String|回调方法|否||

7.3 示例

1. JSBridge.doAction('share',{'title':'分享标题','desc':'分享描述'}) -- 执行native分享页面
2. JSBridge.doAction('setTitle',{'title':'设置的标题'}) -- 设置当前页面的标题

私有方法