混合开发接口文档

最新推荐文章于 2020-12-07 20:49:59 发布
最新推荐文章于 2020-12-07 20:49:59 发布
阅读量1k 收藏 2
点赞数
分类专栏： 文档 文章标签： 混合开发
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/liugang921118/article/details/80283464
版权
本文档详细介绍了混合开发中涉及的各种接口，包括通用接口、设备相关接口、业务接口、状态栏和界面操作等。关键接口如获取设备唯一识别码、网络类型、权限验证、调用系统功能（如打电话、发短信）以及支付接口等，提供了详细的参数说明和使用示例。
摘要由CSDN通过智能技术生成

混合开发接口文档

通用

页面引入js文件

js文件版本在添加升级功能时地址会变化，如有需要（比如要使用新增的js-api）,请随时关注地址变更。但是旧版本js文件也将一直可用。
http://res.dinghuo123.com/app/ydh/dist/js/lib/hybrid.js
这个脚本在客户端执行，判断平台后实际使用不同代码。如果想减少交互次数，可以在服务器直接判断平台后，调取不同的js代码。
Android：http://res.dinghuo123.com/app/ydh/dist/js/lib/hybrid/android/cordova.js
iOS：http://res.dinghuo123.com/app/ydh/dist/js/lib/hybrid/ios/cordova.js

全局变量、命名空间

直接引入hybird.js会得到一个全局变量ydh
命名空间：设备(ydh.device)、业务(ydh.biz)

权限验证

整个app采用全部H5嵌套，原生app只提供部分接口。
原生App应用模块的URL后面所需参数access_token，access_token由H5提供。

接口约定

  • 所有接口都为异步
  • 接受一个object类型的参数
  • 成功回调onSuccess(某些异步接口的成功回调，将在事件触发时被调用，具体详情请查看相关onSuccess回调时机，未做描述的即为同步接口)
  • 失败回调 onFail
  • 如下showToast的接口：
function myBtnOneOnClick(){

    ydh.device.showToast(function(result){
        alert("success:"+result);
    },function(err){
        alert("error:"+err);
    },{
        text:'Hello world again!'
    });
}

设备

ydh.device

获取通用唯一识别码

  • 接口名称

    ydh.device.getUuid

  • 参数说明

    参数参数类型说明
    uuidString通用唯一识别码

获取手机APP版本号和版本名称

  • 接口名称

    ydh.device.getAppVersion

  • 参数说明

    参数参数类型说明
    platformStringAPP平台值：Android、iOS
    versionCodeStringAPP的版本号
    versionNameStringAPP的版本名称

获取当前网络类型

  • 接口名称

    ydh.device.getNetworkType

  • 参数说明

    参数参数类型说明
    resultStringresult值: wifi、2g、3g、4g、unknown、none，none表示离线

toast

  • 接口名称

    ydh.device.showToast

  • 返回说明

    参数参数类型说明
    textString提示信息

业务

ydh.biz

帐号信息

  • 接口说明
    为了确保数据的正确性，请在收到该接口成功回调后进行下一步操作

  • 接口名称

    ydh.biz.setAccountData

  • 参数说明

    参数参数类型说明
    userNameString当前用户名
    accessTokenString访问令牌
    accountTypeString帐号类型（”corp”管理端，”agent”订货端）
    expiresInLong过期时间（秒）

打电话

  • 接口名称

    ydh.biz.call

  • 参数说明

    参数参数类型说明
    phoneString电话号码

发短信

  • 接口名称

    ydh.biz.sendMessage

  • 参数说明

    参数参数类型说明
    telephoneString手机号码
    textString短信内容

文本复制

  • 接口说明

    调用此接口，进行文本复制

  • 接口名称

    ydh.biz.copyText

  • 参数说明

    参数参数类型说明
    copyTextString复制的文本

扫码

  • 接口名称

    ydh.biz.scanCode

  • 参数说明

    参数参数类型说明
    typeStringtype为qrCode或者barCode

保存图片到手机

  • 接口名称

    ydh.biz.saveImage

  • 参数说明

    参数参数类型是否必须说明
    urlString是图片地址
    nameString否图片名称，默认是yyyyMMddHHmmss.jpg，后缀名根据实际的图片类型而定

分享

  • 接口名称

    ydh.biz.shareContent

  • 参数说明

    参数参数类型说明
    urlStringurl地址
    titleString分享标题
    contentString分享内容
    imageString分享的图片
    platformsString传入1到5字符串用逗号隔开(例”1,2,3,4,5”)，其中1-SINA 2-QQ 3-QZONE 4-WEIXIN 5-WEIXIN_CIRCLE

下载

  • 接口说明
    ios专用接口

  • 接口名称

    ydh.biz.download

  • 参数说明

    参数参数类型说明
    downloadUrlString下载地址
  • 返回说明
    无

订单蓝牙打印

  • 接口名称

    ydh.biz.orderBluetoothPrint

  • 参数说明

    参数参数类型说明
    orderNumString订单编号

订单蓝牙打印

  • 接口名称

    ydh.biz.orderBluetoothPrint

  • 参数说明

    参数参数类型说明
    orderNumString订单编号

获取手势密码设置状态

  • 接口说明

    调用此接口，获取手势密码设置状态

  • 接口名称

    ydh.biz.getGesturePasswordStatus

  • 参数说明
    无

  • 返回说明

    参数参数类型说明
    gestureStatusString手势密码状态，0：未启用，1：已启用 ，-1：未设置

获取Android包的渠道值

  • 接口说明
    android专用接口
  • 接口名称
    ydh.biz.getChannelValue

  • 参数说明
    无

  • 返回说明

    参数参数类型说明
    channelIDString渠道id
    channelNameString渠道名称

附件下载本地

  • 接口说明
    android专用接口

  • 接口名称
    ydh.biz.toDownloadAttachment

  • 参数说明

    参数参数类型说明
    attachmentString附件名称
    downloadUrlString附件下载地址
  • 返回说明
    无

获取附件下载状态

  • 接口说明
    android专用接口
    调用此接口，附件是否下载

  • 接口名称

    ydh.biz.onAttachmentListStatus

  • 参数说明

    参数参数类型说明
    attachmentListArrayList附件集合

  • Object说明

    参数参数类型说明
    attachmentString附件
    fileNameString文件名称

  • 返回说明

    参数参数类型说明
    attachmentListStatusArrayList附件下载状态集合

  • Object说明

    参数参数类型说明
    attachmentString附件
    fileNameString文件名称
    isDownloadbooleanture已下载，false未下载

选择图片上传（多图片，拍照是单图片）

  • 接口说明

    将在成功上传之后回调onSuccess方法，返回图片链接。如果选择了拍照上传，则拍完照后马上上传，上传完毕直接返回url给H5页面。调用此接口后，APP将会启动图片选择界面，用户选择图片就进入上传图片等待，待图片上传完毕后将返回图片url数组。

  • 接口名称

    ydh.biz.uploadImages

  • 参数说明

    参数参数类型说明
    multipleBoolean是否多选，默认false
    maxNumbermax为正整数，最多可选个数
    uploadUrlString上传的地址

  • 返回说明

    参数参数类型说明
    imageInfosArray[Object]图片信息列表，信息对象包含attachment,fileName和size等信息

选择文件上传（单文件）

  • 接口说明

    将在成功上传之后回调onSuccess方法，返回文件链接。

  • 接口名称

    ydh.biz.uploadFile

  • 参数说明

    参数参数类型说明
    uploadUrlString上传的地址

  • 返回说明

    参数参数类型说明
    fileInfoObject信息对象包含attachment，attachmentType，fileName和size等信息

拍照上传图片

  • 接口说明

    将在成功上传之后回调onSuccess方法，返回文件链接。

  • 接口名称

    ydh.biz.uploadTakePicture

  • 参数说明

    参数参数类型说明
    uploadUrlString上传的地址

  • 返回说明

    参数参数类型说明
    fileInfoObject信息对象包含attachment，attachmentType，fileName和size等信息

状态栏

ydh.biz.statusBar

设置状态栏属性

  • 接口名称

    ydh.biz.statusBar.setAttributes

  • 参数说明

    参数参数类型是否必须说明
    backgroundColorString否背景颜色，ARGB格式，如#deffffff，为空则不设置

支付

ydh.biz.alipay

支付宝支付

界面

  ydh.biz.ui

打开打印链接界面

  • 接口名称

    ydh.biz.ui.openBluetoothSetting

  • 参数说明
    无

打开手势密码界面

  • 接口名称

    ydh.biz.ui.openSetGesturesPassword

  • 参数说明
    无

  • 返回说明
    无

跳转至新的H5界面

  • 接口名称

    ydh.biz.ui.openPage

  • 参数说明

    参数参数类型是否必须说明
    urlString是新的url地址
    visibleboolean是false表示不显示菜单栏（此时可以不用传title，background），true表示显示菜单栏
    titleString否界面标题，用于设置界面标题，如果为空则界面使用默认的标题
    backgroundString否背景颜色，ARGB格式，如#deffffff，为空则不设置

  • 返回说明
    无

关闭新的H5界面

  • 接口名称

    ydh.biz.ui.finishPage

  • 参数说明
    无

  • 返回说明
    无

  • 备注
    关闭的界面是调用openPage打开的新界面

跳转至易订货主界面

  • 接口名称

    ydh.biz.ui.openMainActivity

  • 参数说明

    参数参数类型是否必须说明
    urlString是主界面的url地址
  • 返回说明
    无
  • 备注
    跳转到易订货主界面，发一个事件去结束登录界面和新开的H5界面

跳转至登录界面

  • 接口名称
    ydh.biz.ui.openLoginActivity

  • 参数说明
    无

  • 返回说明
    无

特别说明

1.html里的事件不能使用内联的方式，必须使用javascript为document添加事件监听方式。

document.getElementById("myBtnOne").addEventListener("click", myBtnOneOnClick);

2.cordova开发如何解决中文乱码？
在html页面增加如下代码。

<meta http-equiv="Content-type" content="text/html; charset=utf-8">

出现乱码的原因是网页与平台(Android/iOS)的编码不一致，而目前Android和iOS项目开发所用的编码均为utf-8，所以在网页需要添加编码配置。

3.Android平台上将APP上的js代码直接放到服务器，然后在APP里调用网页，无法正常运行。
针对WhitelistPlugin类，需要复写shouldAllowBridgeAccess方法。

 /**
  * 链接远程url需要覆写这个方法
  * @param url
  * @return
  */
  @Override
  public Boolean shouldAllowBridgeAccess(String url) {
      return true;
  }

4.无法正常运行的的原因是：WhitelistPlugin默认只支持本地url的加载，而http开头的url则无法通过，所以导致无法正常运行。复写shouldAllowBridgeAccess返回true，则允许通过所有方式进行加载。
Android平台上将APP上的js代码直接放到服务器，然后在iOS平台进行访问，无法正常运行。
由于cordova在Android和iOS平台上SDK的代码不一样，所以出现无法正常运行情况。
解决思路：将Android和iOS平台上的cordova关于js的代码混合起来，然后通过外部参数决定使用哪一个平台的代码。
解决方案：新增hybird.js文件实现逻辑，在url上新增platform参数，值是Android或者iOS，如下

var queryString = getQueryString("platform");
    if(queryString=='Android'){
        include('platform/android/cordova.js');
    }else if(queryString=='iOS'){
        include('platform/ios/cordova.js');
    } else {
        alert('Not Android or iOS platform!');
    }

本地调试时，增加platform参数

<content src="index.html?platform=Android" />

远程调试时，增加platform参数

http://res.dinghuo123.com/app/www/index.html?platform=iOS
那一年的梧桐雨
关注
专栏目录
接口开发文档说明
赵吉平的专栏
06-21 938
接口开发文档说明 3. 带分页的数据列表格式, 如lists接口, 需要传递p:页码(默认1), page_size:一页多少条(默认后台定义10条) 山东艾思软件科技有限公司，是专业的App定制开发, 网站制作企业；为企业提供从软件开发整合运营的一整套方案。App定制开发包括: 办公ERP, OA, CMS, CRM类定制开发, 聊天类APP开发, 电商商城类, 各种制度......
接口开发文档
qq_29124379的博客
06-23 1769
1、场景列表（所属分组、全部分组、全部场景、收藏等） 接口地址：interface/linkMan/allScene 请求参数：无 返回数据： { "code":"0", "msg":"操作成功!", "data":[ { "name":"所属分组2", "type":"10001", "id":"92D1A0D5035820B9E0530100007F8765", ...
接口说明书
08-23
2.1 基本约定 i. 通讯约定：使用WebService方式进行通讯，传输协议：HTTPS，参数不做encode(URL转码)。特殊字符：&$% ii. 参数大小写约定：没有强制要求的地方，统一使用小写。 iii. 编码约定：如GBK或UTF-8等，默认为UTF-8。 iv. 参数约定： XML。 v. 安全约定：1、加密算法暂定为RSA，对报文进行加密，有宇通生成公钥及数字签名文件发给第三方系统，第三方系统使用公钥对报文进行加密和解密，使用数字签名文件对报文进行签名和校验。2、只对敏感数据加密 vi. 消息数量约定：默认一个消息一个订单，单据生成和下发并行，生成多少下发多少。当涉及批量处理时，默认最多处理500个。 vii. 时间约定：时间格式使用 YYYY-MM-DD HH:mm:ss 的格式，精确到秒。
我的接口说明文档模板
07-10
java开发使用的接口说明文档模板
混合开发
胡老大的唯一大老婆的博客
12-09 843
混合开发是一种模式,英文名字hybird APP 顾名思义就是使用native(iOS和Android)和web(html\css\javascript)技术开发 优点:开发快,开发周期短 缺点:性能问题和兼容问题(原生充当浏览器,版本很多,所以兼容性问题可能会有,但是Android5.0和ios9.0以上版本,这个确定也不明显) 混合应用开发: 1.微信公众号:通过jssdk连接native和w...
Go+Python双语言混合开发资料包
02-23
在IT行业中，Go和Python两...这些文档和代码示例为Go和Python的混合开发提供了丰富的学习资源，涵盖了并发控制、分布式系统、微服务架构等多个方面，对于想要深入理解这两种语言结合使用的开发者来说是一份宝贵的资料。
H5混合开发app如何升级的方法
09-27
通过上述的介绍，我们可以看到在H5混合开发app中实现自动升级和手动升级的方法相对比较直接，但需要注意不同平台间处理方式的差异，以及不同编程接口的正确调用。对于开发者来说，了解和掌握这些升级逻辑对于维护一...
uniapp+Android混合开发（傻瓜式教学，有手包会）
05-24
针对uniapp与Android混合开发 集成过程写的操作步骤，用于解决已经有uniapp项目，但因业务需要，需提供原生的接口的场景；该文档只讲述集成混合开发的过程，文档图文结合极为详细 很适合一个完全不懂Android的人来...
MATLAB混合编程与外部接口开发指南.docx
最新发布
08-05
本文档涵盖了 MATLAB 混合编程的概念、与 C/C++/Fortran 的混合编程、与其他脚本语言的混合编程、外部接口开发等方面的内容。 一、MATLAB 混合编程概述 MATLAB 混合编程是指将不同编程语言和工具的代码结合起来，...
JAVA开发规范文档.pdf
10-02
【Java开发规范】是指导程序员遵循的一套标准和准则，旨在提升代码的可读性、可维护性、可扩展性和一致性。以下是对这份规范的详细解释： **代码组织与风格** 1. **长度控制**：函数的有效代码长度推荐在100行以内...
web前端混合app开发实战视频教程
10-21
2018web前端开发-----混合app项目开发实战视频教程，是专门针对某一类移动设备而生的，它们都是被直接安装到设备里，而用户一般也是通过应用商店来获取应用 。 如安装在 iOS 和 Android 设备上的客户端。
cordova 安装后，出现powershell乱码的问题
immortal___的博客
09-16 517
首先确定自己的node和npm都可以正常运行，在cmd中输入node -v，npm -v来检查。 由于powershell出现问题，且提示是乱码，我们需要改变一下powershell的显示编码来定位问题。 使用chcp 65001将编码改为UTF-8，这时窗口会重新启动，再次输入cordova -v就可以看到powershell出现的问题信息。 我出现的问题是Powershell’ is not recognized as an internal or external command, operable
H5+android+cordova混合开发完整流程
Sakuya的博客
12-02 2347
目的 本例是针对H5+android+cordova混合开发的一个示例 开发配置 配置android sdk环境以及java环境 环境变量配置不用多说，基本上网上都有，按着配置一下就好。 安装node.js 直接进入网站下载，链接: node.js. 下载完后通过命令行 输入 node -v 获取版本号检查是否安装成功。 npm是随同node.js一起安装的包管理工具，能解决node.j...
什么是混合开发？前端开发如何调用
ChinaW_804的博客
12-07 5894
首先搞清楚什么是混合APP开发（Hybrid App） HybridApp（混合模式移动应用）是指介于web-app、native-app这两者之间的app，兼具“Native App良好用户交互体验的优势”和“Web App跨平台开发的优势” 通俗来讲，就是将h5我们写好的移动端页面，放到ios设备以及安卓设备中，在里面 我们可以享受ios和安卓给我们的所有支持，通过方法调用，回调函数进行使用 给我们提供的方法 其次搞清楚APP都有哪些类型？ 一，原生APP 现在的智能手机操作系统就是主流的ios和And
如何选择Web APP与Native App原生开发模式的区别
学无止境
03-17 5684
APP开发模式通常分为Web APP与Native APP原生模式两种，这两种模式均各自有自己的优势，到底是采用Native App开发还是采用Web App开发一直是业界争论的焦点，但是随着HTML5的发展及云服务普及，采用HTML5进行Web App开发正在成为一种趋势，用户可以根据应用特点和需求进行选择，亦可选择两者混合模式： 　　Native App开发 　　Native App开发即
h5+runtime Native.js 混合APP连接蓝牙打印机
heartOfblack 离开了电脑，我不希望我还有病
12-26 9904
自己摸索了一下，并参考其他人的代码，修复了原来代码存在的问题， 问题1：字符串的getBytes函数，返回null【需要通过new的方式创建字符串】 问题2：初始化打印一次，之后无法使用【不要重复调用device.createInsecureRfcommSocketToServiceRecord(uuid)或重复引入CLASS】代码如下，可正常运行【注意，蓝牙打印机必须先匹配，保证手机蓝牙打开】
多基站wifi混合定位
weixin_30621919的博客
04-25 175
详情链接：http://www.haoservice.com/docs/3 多基站定位,wifi高精度混合定位 支持格式：JSON/XML 请求方式：GET/POST 明文方式请求参数： 名称 类型 必填 说明 key string 是 API KEY requestdata ...
H5与APP混合开发遇到的问题总结
sinat_39256911的博客
05-05 2342
本文是本人第一次参与公司项目的一个总结文档，文中主要涉及：项目开发中遇到的一些问题的整理。 原文链接(掘金)：https://juejin.im/post/5aa8b00c51882555627cfa0e ...
再读MUI混合插件开发文档
专注写bug
06-29 2786
说实话，官方的文档很难看懂，在经历了几个项目的插件开发后，对插件开发有了个人的理解，同时也深感mui框架开发人员的不易，废话不多说，mui混合插件开发传送通道！ 对于开发文档，相信很多人看了之后都觉得头大，我也不例外，可能还不如你们，我当时看评论区，看见很多牛人说看完照敲一遍，基本就会了，楼主我坐在电脑面前，看文档3天才撸出来一个简单的事例出来，惭愧！ ...
iMenu电子菜单系统接口文档
"iMenu电子菜单接口说明文档详细描述了如何与iMenu系统进行接口交互，包括主动模式、被动模式（WebService）和混合模式（Socket），并重点介绍了基于WebService的被动模式接口，涉及到应用认证、数据初始化、菜品...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值