uplus-api 说明

uplusAPI 核心库是智家APP为接入内部的H5资源包提供的一整套API接口,可以为H5接入资源赋能,实现丰富的业务场景。


支持环境

uplusAPI 核心库基于智家APP环境运行,在普通的PC浏览器或者手机浏览器是无法正常运行的

目前智家APP内部支持uplusAPI核心库运行的webview容器有以下三种类型:

  • cordova (已废弃)
  • apicloud (已废弃)
  • nebula (智家APP目前mpaas原生框架带有的容器)

版本

  • 4.2.0

    `此版本仅支持智家App 6.19.0及以上,受影响模块为upFamilyModule,详细说明请见upFamilyModule模块说明的版本变更部分` `speechrecognition模块重要改动:attach和detach方法必须成对使用,调用了attach方法后在create新的对象之前必须调用detach取消之前的监听,否则新创建的对象无法attach监听。`

安装方式

一、 使用 npm 安装

uplusAPI 目前发布到私有服务器,资源服务器地址为:http://101.200.241.211:8082/nexus/repository/npm-group

在工程根目录添加.npmrc文件,内容如下

@uplus:registry=http://101.200.241.211:8082/nexus/repository/npm-group

我们推荐使用 npm 的方式进行开发 ,不仅可在开发环境轻松调试,也可放心地在生产环境打包部署使用,享受整个生态圈和工具链带来的诸多好处。

$ npm install @uplus/uplus-api --save

二、 浏览器引入

在浏览器中使用 scriptlink 标签直接引入文件,并使用全局构造函数 UplusApi。 我们在 npm 发布包内的 uplus-api/dist 目录下提供了 uplusapi.js `

  <script src="./dist/uplusapi.js"></script>

应用示例

import UplusApi from '@uplus/uplus-api';

const instance = new UplusApi();
instance.initDeviceReady().then(function() {
  instance.upUserModule.getUserInfo().then((res) => {
    console.log(res);
  }).catch(err => console.log(err));
}).catch(err => console.log(err));
<script src="./dist/uplusapi.js"></script>
<script>
  var instance = new UplusApi();
  instance.initDeviceReady().then(function() {
    instance.upUserModule.getUserInfo()then((res) => {
      console.log(res);
    }).catch(err => console.log(err));
  }).catch(err => console.log(err));
</script>

uplusAPI 概览

模块接口说明

0.通用返回值数据结构说明

1.uplus-api 初始化

2.upUserModule 用户模块

3.upLogicEngineModule 逻辑引擎模块

4.upDeviceModule 设备模块

5.upVdnModule VDN模块

6.upShareModule 友盟分享模块

7.upLocationModule 定位模块

8.upHttpModule http模块

9.upImageModule 相机相册模块

10.upAudioRecorderModule 录音模块

11.upTraceModule 打点模块

12.upBleModule 蓝牙模块

13.upPedometerModule 计步器模块

14.upNetworkModule 网络信息模块

15.upAppinfoModule app信息模块

16.upRequestModule 智家服务接口签名请求模块

17.upFamilyModule 家庭模块

18.upSpeechRecognitionModule 语音识别模块

19.upAlbumModule 图片裁剪模块(4.0废弃)

20.扫码模块

21.upLiveModule 直播模块

22.upStorageModule 通用数据存储模块

23.upPermissionModule 权限模块

24.upWeiXinModule 微信相关能力模块

25.upScreenshotModule 截图分享模块

26.upMakeSignModule 签名加密模块

27.upAlipayModule 支付模块

28.upNativeContainerModule 原生容器接口模块

29.upLogModule 日志模块

30.upOSSModule 阿里云资源管理

[31.upQRCodeModule 二维码识别模块(4.0废弃)]

32.upResourceModule 资源模块

33.UpSystemModule 系统基础模块

34.UpInfraredModule 红外模块

35.UpWifiModule wifi信息模块

36.bindModule 绑定模块


属性列表

  • deviceReady: boolean
  • logicEngineModule: 设备逻辑引擎模块
  • upUserModule: 用户模块
  • upDeviceModule: 设备模块
  • upVdnModule: VDN模块
  • upShareModule: 分享模块
  • upLocationModule: 定位模块
  • upHttpModule: http模块
  • upNetworkModule: 网络信息模块
  • upPedometerModule: 计步模块
  • upImageModule: 相机相册模块
  • upBleModule: 蓝牙模块
  • upAudioRecorderModule: 录音模块
  • upTraceModule: 打点模块
  • upNetworkModule: 网络信息模块
  • upAppinfoModule: app信息模块
  • upFamilyModule: 家庭模块
  • upRequestModule: 优家接口签名请求模块
  • upSpeechRecognitionModule: 人工智能模块
  • upAlbumModule: 图片裁剪模块
  • uplive:直播模块
  • upstorage:存储模块
  • upPermissionModule:权限模块
  • upWeiXinModule:微信能力模块
  • upOSSModule:阿里云OSS服务模块
  • upScreenshotModule:截图分享模块
  • upMakeSignModule: 签名加密模块
  • upInfraredModule: 红外模块
  • upWifiModule: wifi信息模块
  • bindModule: 绑定模块

uplusAPI 模块接口支持情况提示

  • uplusAPI 的模块接口如果运行在未知容器中,会弹框提示对应的接口不可用信息 如下图所示

接口未定义

results matching ""

    No results matching ""