2.7.2 • Published 4 months ago

ijsbridge v2.7.2

Weekly downloads
3
License
ISC
Repository
-
Last release
4 months ago

TOC

ijsbridge 接入向导(两种方式)

npm 方式

npm i ijsbridge

script 引入,支持 es5

<script src="https://fastly.jsdelivr.net/npm/ijsbridge/ijsbridge.min.js"></script>

Web调试

chrome内核

请使用 chrome 的 inspect 调试(需翻墙,或部分 chrome 内核浏览器)

chrome://inspect/#devices

ijsbridge 接口文档

import WebBridgeApi from "ijsbridge"

接口 sysinfo

获取设备基本配置/信息

接收参数 无

返回参数
参数说明
Brand设备品牌
SystemName系统名称
SystemVersion系统版本
BundleId包名
ApplicationName应用名
Version版本
DeviceName设备名称
UserAgent设备标记
Carrier运营商
NetInfo网络类型

示例

WebBridgeApi.sysinfo().then(({ err, result }) => {
  console.log("测试桥返回结果sysinfo", result, err);
});

接口 scanCode

打开相机扫描二维码

接收参数 | 参数 | 说明 | | ------ | -------- | | closeAlbums | ture 关闭相册扫码 不传值默认打开 |

返回参数

二维码字符串数据

示例

WebBridgeApi.scanCode().then(({ err, result }) => {
  console.log("测试桥返回结果scanCode", result, err);
});

接口 authorize

获取用户授权,未登录可触发登录

接收参数 无

返回参数

返回用户基本信息(含有 openid)

示例

WebBridgeApi.authorize().then(({ err, result }) => {
  console.log("测试桥返回结果authorize", result, err);
});

接口 getUserInfo

获取用户授权,未登录会触发登录

接收参数 无

返回参数:

返回用户基本信息

示例

WebBridgeApi.getUserInfo().then(({ err, result }) => {
  console.log("测试桥返回结果", result, err);
});

接口 fetch

网络请求

接收参数

参数说明
url请求地址
option请求参数

option 字段说明:

普通 GET 请求: get:{'field1':'','field2':''} || 或者在网址里用 querystring 的形式

普通 POST 请求 post:{'field1':'','field2':''}

上传文件 post:{'file':{ data: '文件数据', type: "image/png", filename: "photo.png" },'field2':''} ||或者 post:{'file':{ path: '本地路径', type: "image/png", filename: "photo.png" },'field2':''}

返回参数
参数说明
header
body内容

示例

WebBridgeApi.fetch({
  url: "http://www.baidu.com",
  option: {
    method: "POST",
    headers: {},
    get: { ka: "", kb: "" },
    post: {
      data: "test",
      file: { path: "", type: "image/png", filename: "photo.png" },
    },
  },
}).then(({ err, result }) => {
  console.log("测试桥返回结果", result, err);
});

接口 router

路由跳转

接收参数

参数说明
route路由名称
params参数
返回参数

示例

WebBridgeApi.router({
  route: "web",
  params: { url: "http://www.baidu.com" },
}).then(({ err, result }) => {
  console.log("测试桥返回结果authorize", result, err);
});

接口 showToast

显示 toast

接收参数

参数说明
title显示内容
duration显示时间 ms
返回参数

示例

WebBridgeApi.showToast({ title: "test" }).then(({ err, result }) => {});

接口 showDialog

提示对话框

接收参数

参数说明
title显示内容
buttons显示时间 ms

buttons 结构 | 参数 | 说明 | | ------- | ------- | | text | 显示内容 |

返回参数

index 第几个

示例

WebBridgeApi.showDialog({title:'test',buttons:[{text:'1'},{text:'2'}]).then(({ err, result }) => {

});

接口 chooseImage

选择本地图片

接收参数 无

返回参数:

返回选择的图片路径

示例

WebBridgeApi.chooseImage().then(({ err, result }) => {
  console.log("测试桥返回结果", result, err);
});

接口 chooseVideo

选择本地视频

接收参数 无

返回参数:

返回选择的视频路径

示例

WebBridgeApi.chooseVideo().then(({ err, result }) => {
  console.log("测试桥返回结果", result, err);
});

接口 showImageViewer

打开图片浏览器

接收参数

参数说明
images图片数组
index首先显示

images 结构 | 参数 | 说明 | | ------- | ------- | | image | 图片地址 | | title | 标题 |

返回参数:

示例

WebBridgeApi.showImageViewer({
  images: [{ image: "http://", title: "" }],
  index: 0,
}).then(({ err, result }) => {});

接口 showFullVideoPlayer

打开全屏视频播放器

接收参数

参数说明
video视频地址

返回参数:

示例

WebBridgeApi.showFullVideoPlayer({ video: "http://" }).then(
  ({ err, result }) => {}
);

接口 checkPermission

权限验证

接收参数

参数说明
permission权限(参照说明)
title提示信息

返回参数:

Bool

示例

WebBridgeApi.checkPermission({
  permission: "location",
  title: "需要您打开定位权限",
}).then(({ err, result }) => {});

权限字串说明 | 说明 | 字串 | IOS |Android | | ------- | ------- | ------- | ------- | | Camera | camera | ✔️ | ✔ | | Contacts | contacts | ✔️ | ✔ | | Events | event | ✔️ | ✔ | | Location | location | ✔️ | ✔ | | Microphone | microphone | ✔️ | ✔ | | Photos | photo | ✔️ | ✔ | | Background Refresh | backgroundRefresh | ✔️ | ❌ | | Bluetooth | bluetooth | ✔️ | ❌ | | Media Library | mediaLibrary | ✔️ | ❌ | | Motion Activity | motion | ✔️ | ❌ | | Push Notifications | notification | ✔️ | ❌ | | Reminders | reminder | ✔️ | ❌ | Speech Recognition | speechRecognition | ✔️ | ❌ | | Coarse location | coarseLocation | ❌ | ✔ | | Phone Call | callPhone | ❌️ | ✔ | | Read SMS | readSms | ❌️ | ✔ | | Receive SMS | receiveSms | ❌️ | ✔ | | Send SMS | sendSms | ❌️ | ✔ | | Storage | storage | ❌️ | ✔ |

接口 audioRecord

录制音频

示例

WebBridgeApi.audioRecord({start:true,time:15}}).then(({ err, result }) => {

});

接收参数

参数说明
start开始/结束(true/false)
time时间(秒),默认 10 秒

返回参数:

Bool

接口 share

示例

WebBridgeApi.share({share:{title:'',desc:'',image:'',url:'',sharePlatform:23,shareType:'WebPage'},id:'这里会',type:'article'}}).then(({ err, result }) => {

});

接收参数

参数说明
share标准的分享字段,包含 title,desc,image,url
id用于统计的索引 id,例如文稿 id
type用于统计的索引类型,例如文稿 article
sharePlatform平台参数
path小程序用
userName小程序用

平台参数 platform

参数说明
1新浪微博
22微信好友
23微信朋友圈
24QQ 好友
6QQ 空间

类型参数 shareType

参数说明
Text文本
Image图片
WebPage网页
App应用
Music音频
Video视频
WechatApplet小程序 注:platform必须为微信好

返回参数:

String

结果消息

接口 openLink

打开外部链接

示例

WebBridgeApi.openLink({ body: "" }).then(({ err, result }) => {});

接收参数

参数说明
body外部链接,同 param

返回参数:

Bool

接口 showPickerMenu

显示下浮菜单(带取消)

示例

WebBridgeApi.showPickerMenu({ items: [{ title: "选项" }] }).then(
  ({ err, result }) => {
    if (!err) console.log(result.item, result.index);
  }
);

接收参数

参数说明
items选项数组(必须有 title)

返回参数:

{item,index}

接口 launchWechatProgram

启动微信小程序

示例

WebBridgeApi.launchWechatProgram({
  userName: "gxxxx",
  path: "",
  extDic: {},
}).then(({ err, result }) => {
  if (!err) console.log(result.item, result.index);
});

接收参数

参数说明
userName微信小程序 id
path启动路径
extDic附加参数

返回参数:

Bool

接口 获取定位信息

获取定位信息

示例

WebBridgeApi.getCurrentPosition({ type: "gaode" }).then(
  ({ err, result }) => {}
);

接收参数 无

返回参数:

逆编码

参数说明
latitude经度
longitude经度
address格式化地址
poiName兴趣点
country国家
province
city
cityCode城市编码
district区县
street街道
streetNumber门牌号
adCode区域编码

非逆编码

参数说明
latitude经度
longitude经度

接口 registerAppEvent

注册全局事件(app)

示例

WebBridgeApi.registerAppEvent({ event: "update" }, ({ err, result }) => {});

接收参数

参数说明
event事件标记

返回参数:

Bool

接口 unRegisterAppEvent

注销全局事件

示例

WebBridgeApi.unRegisterAppEvent({ event: "update" }).then(
  ({ err, result }) => {}
);

接收参数

参数说明
event事件标记

返回参数:

Bool

接口 triggerAppEvent

触发全局事件

示例

WebBridgeApi.triggerAppEvent({ event: "update", params: { a: 1 } }).then(
  ({ err, result }) => {}
);

接收参数

参数说明
event事件标记
params传递参数(非引用变量)

返回参数:

Bool

接口 navigatorConfig (webapp)

更改导航配置

示例

WebBridgeApi.requestApi('navigatorConfig',{title:'导航栏标题',right:{icon:"adb",handle:()=>{}});

接收参数

参数说明
title导航栏标题
right右导航按钮 icon 字体图标 handle 点击事件

其中字体图标目前只支持 MaterialIcons 图标,全部图标请浏览 https://oblador.github.io/react-native-vector-icons/

接口 orientation

旋转屏幕 版本 1.3.0+

示例

WebBridgeApi.orientation({ orientation: "LANDSCAPE" });

接收参数

参数说明
orientation旋转方向 支持 PORTRAIT、LANDSCAPE、LANDSCAPE-RIGHT、UNLOCK

接口 connectDlna

投屏 版本 1.3.0+

示例

WebBridgeApi.connectDlna({ media: "视频地址" });

接收参数

参数说明
media视频地址,只支持 http(s)协议

接口 musicControl

锁屏声音控制 版本 1.3.0+

示例

//初始化
WebBridgeApi.musicControl({
  item: {
    title: "", //标题
    artwork: "", //底图 or logo
    artist: "",
    album: "",
  },
});

//更改状态
WebBridgeApi.musicControl({ state: "play" }); //play or pause

//停止
WebBridgeApi.musicControl({ stop: true });

定义本地监听

WebBridgeApi.defineApi("onMusicControl", ({ play, pause }) => {
  //播放
  if (play) {
    return;
  }

  //暂停
  if (pause) {
    return;
  }
});

接收参数

参照示例


其他接口


接口 faceDetect

 人像识别(广告机)

示例

WebBridgeApi.requestApi("faceDetect", { user: { groupId: "" } });

接收参数

参数说明
user用户数据,必须包含 groupId
dbSource同步接口地址

注:(dbSource) http://***/face/list?orgid=29&size={size}&username={userName}&department_id=2818&department_type=2

参数说明
size单页长度
userName最后用户名

返回参数

参数说明
image本地人像图片
groupId人像组
userId人像 ID
userInfo人像信息
userName人像名

接口 faceRegister

 人像注册(广告机)

示例

WebBridgeApi.requestApi("faceRegister", {
  user: { userName: "", groupId: "", userInfo: "" },
});

接收参数

参数说明
user用户数据,必须包含 userName, groupId, userInfo,三项数据
dbSource同步接口地址

返回参数

参数说明
image本地人像图片
groupId人像组
userId人像 ID
userInfo人像信息
userName人像名
feature状态码

接口 cardDetect

 身份证识别(广告机)

示例

WebBridgeApi.requestApi('cardDetect',{start:1,stop:0,once:1}}});

接收参数

参数说明
start开始识别
stop结束识别
once是否只识别一次

返回参数

参数说明
name姓名
sex性别
birth生日
address地址
id_num身份证
photo本地头像

接口 readeFile

 读取本地文件(1.6.4+)

示例

WebBridgeApi.OS.readeFile(input);

接收参数(input)

参数说明
path文件路径
encoding编码格式("utf8", "base64", "ascii" 默认 base64)

返回参数 文件内容

接口 saveFile

 保存文件(1.6.4+)

示例

WebBridgeApi.OS.saveFile(input);

接收参数

参数说明
path文件路径
encoding编码(同上)
body内容

返回文件路径

接口 unzip

 保存文件(1.6.4+)

示例

WebBridgeApi.OS.unzip(input);

接收参数

参数说明
path文件路径
body内容变量(跟 path 二选一)
encoding编码(同上)
pass加密压缩密码

文件解压返回解压文件列表 内容解压返回内容

本地接口 onMusicControl

 获取音频控制(1.6.2+)

示例

WebBridgeApi.defineApi("onMusicControl", (err, res) => {});

接收 res 参数

参数说明
play播放
seek跳转到指定帧
pause暂停

本地接口 schemeOpen

 捕获唤起 url(1.6.2+)

示例

WebBridgeApi.defineApi("schemeOpen", (err, res) => {});

接收 res 参数

参数说明
url唤起的 url

本地接口 shake

 捕获摇一摇(1.6.4+)

示例

WebBridgeApi.defineApi("shake", (err) => {});
2.7.2

4 months ago

2.7.0

8 months ago

2.7.1

8 months ago

2.6.11

1 year ago

2.6.12

10 months ago

2.6.10

2 years ago

2.6.9

2 years ago

2.6.8

2 years ago

2.4.1

2 years ago

2.4.0

2 years ago

2.4.3

2 years ago

2.6.0

2 years ago

2.4.2

2 years ago

2.6.3

2 years ago

2.6.2

2 years ago

2.3.8

2 years ago

2.3.7

2 years ago

2.5.0

2 years ago

2.5.1

2 years ago

2.3.6

2 years ago

2.6.5

2 years ago

2.6.4

2 years ago

2.6.7

2 years ago

2.6.6

2 years ago

2.3.4

2 years ago

2.3.5

2 years ago

2.3.3

3 years ago

2.3.0

3 years ago

2.3.2

3 years ago

2.2.2

3 years ago

2.2.1

3 years ago

2.2.0

3 years ago

2.1.0

3 years ago

1.5.1

3 years ago

1.5.0

3 years ago

1.4.15

4 years ago

1.4.14

4 years ago

1.4.13

4 years ago

1.4.11

4 years ago

1.4.12

4 years ago

1.4.10

4 years ago

1.4.9

4 years ago

1.4.8

4 years ago

1.4.7

4 years ago

1.4.6

4 years ago

1.4.5

4 years ago

1.4.3

4 years ago

1.4.2

4 years ago

1.4.1

4 years ago

1.4.0

4 years ago

1.3.2

4 years ago

1.3.1

4 years ago

1.3.0

4 years ago

1.2.6

4 years ago

1.2.5

4 years ago

1.2.4

4 years ago

1.2.3

4 years ago

1.2.2

4 years ago

1.2.1

4 years ago

1.2.0

4 years ago

1.1.10

4 years ago

1.1.9

4 years ago

1.1.8

4 years ago

1.1.7

4 years ago

1.1.6

4 years ago

1.1.5

4 years ago

1.1.4

4 years ago

1.1.3

4 years ago

1.1.1

4 years ago

1.1.2

4 years ago

1.0.9

4 years ago

1.0.8

4 years ago

1.0.7

5 years ago

1.0.6

5 years ago

1.0.5

5 years ago

1.0.4

5 years ago

1.0.3

5 years ago

1.0.2

5 years ago

1.0.1

5 years ago