1.设备相关API
- 目录
- 文件引用
- 1.1 获取系统信息【iOS】【Android】
- 1.2 获取地理位置【暂未实现】
- 1.3 从地图选取地址【暂未实现】
- 1.4 在地图上打开地址信息【暂未实现】
- 1.5 获取网络类型 【Android】
- 1.6 监听网络状态变化【暂未实现】
- 1.7 拨打电话 【Android】【iOS】
- 1.8 扫描二维码 【Android】【iOS】
- 1.9 扫描二维码并默认处理 【Android】【iOS】
- 1.10 保存到剪切板【iOS】【Android】
- 1.11 获取系统剪切板内容【iOS】【Android】
- 1.12 从本地相册选择图片或使用相机拍照。【Android】
- 1.13 预览图片【暂未实现】
文件引用:
-
在入口文件中的head中引入js文件
run.work.jssdk.bundle.min.js
-
注:在引入js文件后需要调用
crhReady()
方法进行初始化
1.1 获取系统信息【iOS】【Android】
方法:crh.getDeviceInfo(OBJECT)
JSBridgeHook:crh_common_get_device_info
获取系统信息。
OBJECT参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
success | Function | 是 | 接口调用成功的回调 |
fail | Function | 否 | 接口调用失败的回调函数 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
success返回参数说明:
参数 | 类型 | 说明 |
---|---|---|
platform | String | 客户端平台 iOS/Android |
system | String | 操作系统版本 7.0 |
model | String | 手机型号 |
appVersion | String | 应用版本号 |
pixelRatio | String | 设备像素比 |
screenWidth | String | 屏幕宽度 |
screenHeight | String | 屏幕高度 |
deviceID | String | 设备ID |
示例代码:
crh.getDeviceInfo({
sucess:function (data) {
}
});
1.2 获取地理位置【暂未实现】
方法:crh.getLocation(OBJECT)
JSBridgeHook:crh_common_get_current_location
获取当前位置信息。
OBJECT参数说明: 无
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
success | Function | 是 | 接口调用成功的回调 |
fail | Function | 否 | 接口调用失败的回调函数 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
success返回参数说明:
参数 | 类型 | 说明 |
---|---|---|
latitude | Float | 纬度,浮点数,范围为-90~90,负数表示南纬 |
longitude | Float | 经度,浮点数,范围为-180~180,负数表示西经 |
speed | Float | 速度,浮点数,单位m/s |
accuracy | Float | 位置的精确度 |
addressInfo | OBJECT | 位置的详细信息 |
示例代码:
crh.getLocation({
success:function(data){
}
});
1.3 从地图选取地址【暂未实现】
方法:crh.chooseLocation(OBJECT)
JSBridgeHook:crh_common_choose_loaction
从地图选取地址信息。
OBJECT参数说明: 无
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
success | Function | 是 | 接口调用成功的回调 |
cancel | Function | 否 | 用户取消时调用 |
fail | Function | 否 | 接口调用失败的回调函数 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
success返回参数说明:
参数 | 类型 | 说明 |
---|---|---|
latitude | Float | 纬度,浮点数,范围为-90~90,负数表示南纬 |
longitude | Float | 经度,浮点数,范围为-180~180,负数表示西经 |
addressInfo | OBJECT | 位置的详细信息 |
示例代码:
crh.chooseLocation({
success:function(data){
}
});
1.4 在地图上打开地址信息【暂未实现】
方法:crh.openLocation(OBJECT)
JSBridgeHook:crh_common_open_loaction_in_map
从地图选取地址信息。
OBJECT参数说明: 无
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
latitude | Float | 是 | 纬度,范围为-90~90,负数表示南纬 |
longitude | Float | 是 | 经度,范围为-180~180,负数表示西经 |
scale | INT | 否 | 缩放比例,范围5~18,默认为18 |
name | String | 否 | 位置名 |
address | String | 否 | 地址的详细说明 |
success | Function | 否 | 接口调用成功的回调函数 |
fail | Function | 否 | 接口调用失败的回调函数 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
success返回参数说明:无
示例代码:
crh.openLocation({
param:{
latitude: -30,
longitude: 114,
scale: 28
}
})
1.5 获取网络类型 【Android】
crh.getNetworkType(OBJECT)
JSBridgeHook:crh_common_get_current_network_type
获取网络类型。
OBJECT参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
success | Function | 是 | 接口调用成功,返回网络类型 networkType |
fail | Function | 否 | 接口调用失败的回调函数 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
success返回参数说明:
参数 | 类型 | 说明 |
---|---|---|
networkType | String | 网络类型 |
crh.getNetworkType({
success: function(res) {
// 返回网络类型, 有效值:
// wifi/2g/3g/4g/unknown(Android下不常见的网络类型)/none(无网络)
}
})
1.6 监听网络状态变化【暂未实现】
crh.onNetworkStatusChange(CALLBACK)
JSBridgeHook:crh_common_on_network_status_change
监听网络状态变化。
CALLBACK返回参数:
参数 | 类型 | 说明 |
---|---|---|
isConnected | Boolean | 当前是否有网络连接 |
networkType | String | 网络类型 |
networkType 有效值:
值 | 说明 |
---|---|
wifi | wifi 网络 |
2g | 2g 网络 |
3g | 3g 网络 |
4g | 4g 网络 |
none | 无网络 |
unknown | Android下不常见的网络类型 |
示例代码:
crh.onNetworkStatusChange(function(res) {
console.log(res.isConnected)
console.log(res.networkType)
})
1.7 拨打电话 【Android】【iOS】
crh.makePhoneCall(OBJECT)
JSBridgeHook:crh_common_make_call_phone
OBJECT参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
phoneNumber | ArrayString | 是 | 需要拨打的电话号码 |
success | Function | 否 | 接口调用成功的回调 |
fail | Function | 否 | 接口调用失败的回调函数 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
示例代码:
crh.makePhoneCall({
param:{
phoneNumber: ['13923888888'] //仅为示例,并非真实的电话号码
}
})
1.8 扫描二维码 【Android】【iOS】
crh.scanCode(OBJECT)
JSBridgeHook:crh_common_scan_code
调起客户端扫码界面,扫码成功后返回对应的结果
Object 参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
success | Function | 否 | 接口调用成功的回调函数,返回内容详见返回参数说明。 |
fail | Function | 否 | 接口调用失败的回调函数 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
success返回参数说明:
参数 | 类型 | 说明 |
---|---|---|
result | String | 所扫码的内容 |
示例代码:
crh.scanCode({
success: (res) => {
console.log(res.result)
}
})
1.9 扫描二维码并默认处理 【Android】【iOS】
crh.scanCodeAndHandle(OBJECT)
JSBridgeHook:crh_common_scan_code_and_hanlde
调起客户端扫码界面,扫码成功由原生默认处理结果,如:如果扫描的结果为URL,则用webview打开该页面;如果扫描的结果为添加好友,则跳转至添加好友。
Object 参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
success | Function | 否 | 接口调用成功的回调函数,返回内容详见返回参数说明。 |
fail | Function | 否 | 接口调用失败的回调函数 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
success返回参数说明:
参数 | 类型 | 说明 |
---|---|---|
result | String | 所扫码的内容 |
示例代码:
crh.scanCodeAndHandle();
1.10 保存到剪切板【iOS】【Android】
crh.setClipboardData(OBJECT)
JSBridgeHook:crh_common_set_clip_board_data
设置系统剪贴板的内容
OBJECT参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
data | String | 是 | 需要设置的内容 |
success | Function | 否 | 接口调用成功的回调函数 |
fail | Function | 否 | 接口调用失败的回调函数 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
示例代码:
crh.setClipboardData({
param:{
data: 'mango app'
},
success: function() {
}
})
1.11 获取系统剪切板内容【iOS】【Android】
crh.getClipboardData(OBJECT)
JSBridgeHook:crh_common_get_clip_board_data
获取系统剪贴板内容
OBJECT参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
success | Function | 否 | 接口调用成功的回调函数 |
fail | Function | 否 | 接口调用失败的回调函数 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
success返回参数说明:
参数 | 类型 | 说明 |
---|---|---|
data | String | 剪贴板的内容 |
示例代码:
crh.getClipboardData({
success: function(res){
console.log(res.data)
}
})
1.12 从本地相册选择图片或使用相机拍照。【Android】
crh.chooseImage(OBJECT)
JSBridgeHook:crh_common_choose_image
从本地相册选择图片或使用相机拍照。
OBJECT参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
count | Number | 否 | 最多可以选择的图片张数,默认1 |
sizeType | StringArray | 否 | original 原图,compressed 压缩图,默认二者都有 |
sourceType | StringArray | 否 | album 从相册选图,camera 使用相机,默认二者都有 |
success | Function | 是 | 成功则返回图片的Base64列表 images |
fail | Function | 否 | 接口调用失败的回调函数 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
success返回参数说明:
参数 | 类型 | 说明 |
---|---|---|
images | DicArray | 图片的本地文件路径列表 |
示例代码:
crh.chooseImage({
param:{
count: 1, // 默认1
sizeType: ['original', 'compressed'], // 可以指定是原图还是压缩图,默认二者都有
sourceType: ['album', 'camera'], // 可以指定来源是相册还是相机,默认二者都有
},
success: function (res) {
// 返回选定照片的base64数据流
var images = res.images;
}
})
1.13 预览图片【暂未实现】
crh.previewImage(OBJECT)
JSBridgeHook:crh_common_preview_image
预览图片。
OBJECT参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
current | String | 否 | 当前显示图片的链接,不填则默认为 urls 的第一张 |
urls | StringArray | 是 | 需要预览的图片链接列表 |
success | Function | 否 | 接口调用成功的回调函数 |
fail | Function | 否 | 接口调用失败的回调函数 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
示例代码:
crh.previewImage({
param:{
current: '', // 当前显示图片的http链接
urls: [] // 需要预览的图片http链接列表
}
})