vk-hybrid v2.0.1

vk-hybrid APP桥协议SDK

GIT库地址

背景：

目前项目较多，不同团队可能在负责不同的项目，但每个项目中都使用了相同的接口与端通信。这些接口较为分散，没有复用性。
为了便于统一管理和及时更新端的通信能力，现将这些接口封装成NPM包，方便各个团队和业务线安装使用。

安装:

npm install vk-hybrid --registry=http://registry.vnpm.vipkid.com.cn

npm install http://registry.vnpm.vipkid.com.cn/vk-hybrid/download/vk-hybrid-版本号.tgz --save

当前最新版本是 2.0.1

一、基础能力

使用：

import {CommonBridge} from 'vk-hybrid'

//后退       
CommonBridge.historyBack()
  
//显示toast
ParentBridge.toastShow({
  text: '显示toast',
  duration: 1000 (可选，默认为2000)
})

app的基础信息

{
    uid:	设备id
    app:	app名称  study-iPad
    vn:	app三位版本号，字符串类型	  1.0.1
    vc:	app版本码，数字类型，根据四位版本号计算得出的
    os:	操作系统标识， iOS: i, android: a
    ovn:	操作系统名称	 iPhone OS
    ovc:	操作系统版本
    mod:	设备类型	 iPad3,1
    man:	设备制造商	 Apple
    dis:	屏幕宽高: height_width	 1024_768
    den:	屏幕密度	 2
    net:	网络类型
    aid:	app包名	 com.vipkid.study-iPad
    apn:	手机网络运营商
}

app暴露的方法

{
    module1: [method1, method2, method3],
    module2: [method1, method2]
}

跳转页面

后退

显示loading

隐藏loading

显示toast

事件

例：
    Common.on('pageShow', () => {
        //TODO
    })

二、家长端：

使用：

import {ParentBridge} from 'vk-hybrid'

调用方法：
    //打开相册
    ParentBridge.applyPermission({
      permissions: 'album|camera'
    })
      .then(res => {
        //TODO
      })
      .catch(err => {
        //TODO
      })

    //音频播放
    ParentBridge.audio.play({
      index: 0
    })

事件监听
    //iOS内购
    ParentBridge.on('innerPurchaseFinish', function(res){
        // TODO
    })

当前页面是否加载完成

应用权限

音视频播放

电话

日历

calendarData：
    [{
        title：日历的title，字符串类型
        location：日历位置信息，可以作为副标题，目前为空，字符串类型
        startDate：日历开始时间，毫秒时间戳
        endDate：日历结束时间，毫秒时间戳
        alarmArray：日历提醒的时间，数组中是提醒的分钟数
        notes：日历的备注，目前包括课程详细信息和课表短链，字符串类型
        onlineClassId：对应此节课的课程id（用于唯一标识日历）
    }]
    
回调：
    {
      "status":客户端同步状态结果
      "message": 失败信息，字符串，如果成功，传OK
    }
    日历状态同步结果：1xx
    权限状态同步结果：2xx
    
    101：课表已同步至手机日历
    102：课表同步失败，请刷新界面后重试
    103：暂无课表信息同步至日历
    104：尚未设定日历（iOS）
    201:日历权限申请失败，暂无法同步(Android)

Link分享

channel：
    wechat：微信好友
    moments：朋友圈
    sina：新浪微博
    qqzone：QQ空间
    
回调：
    {
      "result": 分享结果；值为0，表示分享成功；值为1，表示分享失败；值为2，表示分享取消；值为3，表示未知；
      "channel": 实际分享的渠道；值跟参数说明中的渠道值相对应，且值一致
    }
    

小程序分享

图片分享

微信支付

回调:
    {
      "result": 支付结果；值为0，表示支付成功；值为1，表示支付失败；值为2，表示支付取消；值为3，表示异常,
      "reason": 支付结果异常时的具体原因。 NOT_SUPPORT：渠道不支持；INVALID_PARAMS：参数错误；INVALID_DATA：数据错误；NOT_INSTALL：第三方应用未安装
    }
    

默认方式支付

channel：
    cmblife：掌上生活
    zl：招联（v2.5.0开始支持）
    webank：微众（v2.6.0开始支持，待测试，请勿直接使用，使用前联系 何行舟(R&D)）
    baidu：百度钱包（v2.6.0开始支持，待测试，请勿直接使用，使用前联系 何行舟(R&D)）
    

支付宝支付

获取当前网络

{
  "netType": 当前网络状态。none(无网络)；2g；3g；4g；wifi；other(其他)
}

用户登录

{
    "state": 用户若取消登录，则返回cancel；若登录成功，则返回success
    "channel": 用户是登录方式登录成功，则返回login；用户是注册的方式登录成功，则返回register
}

用户退出

获取接口请求的必要字段

未登录：
    {
        "vkSessionId":"xxxx"//当前使用的session id
    }
已登陆：
    {
        "parentId":"",//家长id
        "token":"xxxx",//当前用户token
        “studentId”:"",//当前孩子id
        "vkSessionId":"xxxx"//当前使用的session id
    }

标签栏

{
  "result": 表示设置操作是否成功；若返回true，则表示设置成功；若返回false，则表示不支持相应的设置
}

点击事件埋点

触发事件埋点

生命周期埋点

显示升级提示

{
    "data":"https://file.vipkid.com.cn/apps/vipkid_v2.5.1_33882368_default.apk",
    "message":"更新内容：\n1. 课表添加了取消约课按钮，一键取消预约\n2. 修复部分设备界面底部黑条问题\n3. 优化部分页面体验\n",
    "version":"33882368",
    "versionName":"2.5.1",
    "forceUpgrade":false,
    "slientDownload":false,
    "title":"有新版本啦",
    "titleApkExist":"新版本下载完啦",
    "negativeButtonTitle":"暂不升级",
    "positiveButtonTitle":"立即升级",
    "negativeButtonTitleApkExist":"暂不安装",
    "positiveButtonTitleApkExist":"立即安装",
    "apkMD5":"6fce8704ef9dc01bc0371ec7f971560b",
    "apkSize":"28M"
}

剪切板功能

{
  "result":true
}

扫码功能

{
   "result":true（或者false）
}

IM入口展示隐藏

{
  "result":200/400,
  "message":"OK"
}

ios内购

{
  "status":200, //发起购买时客户端的状态结果 200：客户端发起购买成功；500：客户端发起购买失败；501：客户端有之前未结束的购买
  "message":"OK" //失败信息，字符串，如果成功，传OK
}

{
  "result":200, //内购最终结果情况 200：内购最终结果成功；500：内购最终结果失败
  "msg":"OK" //失败信息，字符串，如果成功，传OK
}

本地音频播放器

ParentBridge.audio.init的回调：
    {
      "result": true:表示初始化参数正确合法；false:表示初始化参数异常或者播放器初始化,
      "message": 错误信息
    }

ParentBridge.audio.getProgress的回调：
    {
    "progress":10// 播放进度
    }    

例：
    ParentBridge.audio.on('startPlay', (msg) => {
        // TODO
    })
       

三、教师端：

使用：

import {TeacherBridge} from 'vk-hybrid'

//打开相册       
TeacherBridge.shareInfo({
  "title":"" 分享内容标题
  "desc":"" 分享内容描述
  "imgUrl":"", 分享图片链接
  "link":"",分享链接
})
  
//录音功能
TeacherBridge.record.startRecord({
  maxDuration: '20000'
})

录音功能

{
    "nativeType":"android",//设备
    "eventType":"", //事件类型（EVENT_NATIVE_RECORD_AMPLITUDE_UPDATE//录音音量振幅事件 EVENT_NATIVE_RECORD_COMPLETED //录音完成事件EVENT_NATIVE_RECORD_EXCEPTION //录音失败事件）
    "amplitude":XXXX,//录音音量振幅
    "filePath":"XXXX",//录音文件本地地址
    "errorCode":XXXX//录音失败错误码
}

{
    "nativeType":"android",//设备
    "filePath":"XXXX",//录音文件本地地址
}

媒体播放功能：

上传功能

{
    "nativeType": "android", //设备
    "eventType": "",//事件类型（EVENT_NATIVE_UPLOAD_COMPLETED//上传完成事件
    EVENT_NATIVE_UPLOAD_EXCEPTION//上传失败事件）
    "fileInfo": {
        "fileUrl": "",
        "bucketName": "",
        "key": "",
        "teacherId": ""
    }
}

分享

{
    "title":"" 分享内容标题
    "desc":"" 分享内容描述
    "imgUrl":"", 分享图片链接
    "link":"",分享链接
}

选择视频等自运营相关功能

javascript:window.nativeCallBack() |
{
    “duration”: 视频时长限制,
    "framerate": 视频帧率,
    "coderate": 视频码率,
    "forbidconvert": 禁止转码，1禁止，0不禁止,
    "maxsize": 视频上传最大大小 MB,
    "exportLevel": iOS相册压缩质量（0、1、2）
    "title": 活动标题,
    "tag": 活动 tag,
    "activityId": 活动 ID
}

H5 检查 APP 权限

{
    code: 200/500,
    message: "xxxx"
}
注：200为申请成功，500为申请失败

page功能

recruit功能