APP与H5交互接口定义

一. APP需要处理事项

  1. 设置WebView的UserAgent
    Android以及iOS需要在WebView里重新设置UserAgent,H5需要根据UserAgent来判断目前客户端是哪种WebView。APP里UserAgent的设置格式为:"默认UserAgent" + ";" + "特定WebView标识"。
    WebView类型 UserAgent 备注
    Android HMAndroidWebView
    iOS UIWebView HMiOSUIWebView 表示是UIWebView
    iOS WKWebView HMiOSWKWebView 表示是WKWebView
    范例:
    Mozilla/5.0 (Linux; Android 5.0; SM-G900P Build/LRX21T) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.99 Mobile Safari/537.36;HMAndroidWebView
    前面部分是系统默认设置的UserAgent,在后面拼上";HMAndroidWebView"即可,注意用";"进行分割开来。
  2. WebView从不可见到可见事件通知
    如果打开某个WebView,再从WebView界面跳转到其他界面,然后再返回到WebView界面,原生APP必须触发一个js方法调用,通知H5该事件的发生,H5可以考虑是否需要刷新数据等。事件通知方法定义为:
    function onResume() {
    //H5根据情况考虑是否实现此方法
    }
    二. js与原生交互方法定义
  3. 判断用户是否登录
    方法名:checkLogin
    参数:无
    返回值:boolean true为已登录,false为未登录
  4. 获取APP端请求头信息
    方法名:getHeaders
    参数:无
    返回值:json格式的字符串
    字段名称 类型 备注
    deviceId string 设备唯一id
    rptTime string
    operKind string CUSTOMER
    osType string 系统类型,Android或者iOS
    osVer string 手机操作系统版本号
    appChannel string 当前app的渠道名
    deviceType string 设备型号
    appVer string 当前app的版本号
    rptGpsX string 经纬度
    rptGpsY string 经纬度
    3.获取用户信息
    方法名:getUserInfo
    参数:无
    返回值:json格式的字符串
    字段名称 类型 备注
    userId string 用户id
    token string 登录后的token
    showId string 用户显示id
    nickName string 昵称
    avatarUrl string 头像
    mobile string 手机号
    type int 用户类型:CSub(1), CPlus(2), BSub(3), BPlus(4), ASub(5), APlus(6)
    sex int 性别:0-女,1-男,3-未知
    name string 姓名
    mailAddr string 邮箱地址
    idCardNum string 身份证号
    location string 城市
    mainIncome int 主收入:None(1, "无"), Wages(2, "工资"), Business(3, "生意"), Investment(4, "投资"), Parents(5, "父母资助"), Else(6, "其他")
    secondIncome int 次收入
  5. 关闭当前WebView
    方法名:closeWebView
    参数:无
    返回值:无
  6. 拨打电话
    方法名:callPhone
    参数:
    字段名称 类型 备注
    phone string 电话号码
    返回值:无
  7. 采用原生存储key-value键值对
    方法名:setStorage
    参数:
    字段名称 类型 备注
    key string 注意相同的key值会被覆盖掉
    value string 要存储的字符串内容,任意格式
    返回值:无
  8. 获取原生存储的字符串值
    方法名:getStorage
    参数:
    字段名称 类型 备注
    key string
    返回值:string,获取通过setStorage方法存储的字符串
  9. 通过外部浏览器打开url链接
    方法名:openUrlThroughBrowser
    参数:
    字段名称 类型 备注
    url string 网页地址
    返回值:无
  10. 通过一个新的WebView打开url链接
    方法名:openUrlThroughWebView
    参数:
    字段名称 类型 备注
    url string 网页地址
    返回值:无
  11. 通过路由来进行原生页面跳转
    方法名:navigateByRouter
    参数:
    字段名称 类型 备注
    routerUrl string 路由地址
    返回值:无
  12. 拍照或者从相册选择图片
    方法名:selectPicture
    参数:
    字段名称 类型 备注
    selectType string camera-打开相机,album-打开相册,cameraAndAlbum-弹出选择打开相机和相册的对话框
    width int 图片进行裁切的宽度,如果不需要裁切则传0
    height int 图片进行裁切的高度,如果不需要裁切则传0
    callbackName string 图片获取成功之后的回调方法名,APP端需要把图片路径当做参数传递过去:callback(path)
    返回值:无
  13. 设置导航栏右边按钮及功能
    方法名:setNavigationBarRightMenu
    参数:
    字段名称 类型 备注
    btnText string 按钮显示名称
    functionName string 点击按钮后,APP调用H5的方法名称
    params string 传递的参数
    返回值:无
  14. 保存图片到本地
    方法名:savePicture
    参数:
    字段名称 类型 备注
    imgUrl string 图片地址url
    返回值:无
  15. 图片分享
    方法名:shareImage
    参数:
    字段名称 类型 备注
    imgUrl string 要分享的图片地址url
    channels string 分享的渠道:save-保存图片,weixin-微信,wxcircle-朋友圈,weibo-微博,qq-QQ,sms-短信,按顺序多个渠道用逗号","分隔,例如:save,weixin,qq,则弹出的分享面板依次为“保存、微信、QQ”
    返回值:无
  16. 链接分享
    方法名:shareLink
    参数:
    字段名称 类型 备注
    title string 标题
    desc string 描述
    url string 链接地址
    channels string 同图片分享一样
    返回值:无
  17. 纯文本分享
    方法名:shareText
    参数:
    字段名称 类型 备注
    text string 要分享的文本内容
    channels string 同图片分享一样
    返回值:无
  18. 掉起APP端用户登录窗口
    方法名:toUserLoginPage
    参数:无
    返回值:无
  19. 用户退出登录
    方法名:userLogout
    参数:无
    返回值:无
  20. 设置导航栏标题
    方法名:setWebViewTitle
    参数:
    字段名称 类型 备注
    title string 标题
    返回值:无
  21. 查看网页图片进行缩放
    方法名:viewLargeImage
    参数:
    字段名称 类型 备注
    images string 网页里的图片url地址,多个用","分开
    index int 要显示数组里的图片索引值
    返回值:无
  22. toast
    方法名:toast
    参数:
    字段名称 类型 备注
    msg string
    返回值:无
  23. 显示alert弹窗
    方法名:showAlertDialog
    参数:
    字段名称 类型 备注
    params json json格式的字符串,用于配置弹窗内容
    以下为params参数范例,弹窗会根据buttons的配置按顺序依次显示按钮:
    {
    "title": "标题",
    "msg": "弹窗内容",
    "buttons": [{
    "name": "取消",
    "callback": "callbackFunc1"
    },
    {
    "name": "确定",
    "callback": "callbackFunc2"
    }
    ]
    }
    返回值:无
  24. 选择城市
    方法名:selectCity
    参数:
    字段名称 类型 备注
    callback string js回调函数名,原生APP获取到城市之后,通过该函数传递给js

返回值:

  1. 回到首页
    方法名:toHomePage
    参数:无
    返回值:无
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,980评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,178评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,868评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,498评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,492评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,521评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,910评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,569评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,793评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,559评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,639评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,342评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,931评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,904评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,144评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,833评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,350评论 2 342

推荐阅读更多精彩内容