4.9.3 • Published 4 months ago

rural-sdk v4.9.3

Weekly downloads
-
License
MIT
Repository
-
Last release
4 months ago

Rural SDK

一、Usage

获取宿主信息。

二、SDK API

1. getUserInfo

获取用户信息

import { getUserInfo } from "rural-sdk";

const info = getUserInfo();

返回值

object

类型说明
namestring用户名
phonestring手机号

2. getLevelInfo

获取账号类型信息;

import { getLevelInfo } from "rural-sdk";

const info = getLevelInfo();    

返回值

object

类型说明
typestring//10:市, 0:区, 1:街道, 2:社区
citystring
cityCodestring市级code
areastring区县
areaCodestring区县级code
streetstring街道
streetCodestring街道级code
communitystring社区
communityCodestring社区级code

2.1 getLevelInfoRow

获取账号类型信息(返回原始信息);

import { getLevelInfo } from "rural-sdk";

const info = getLevelInfo();    

返回值

object

类型说明
typestring//10:市, 0:区, 1:街道, 2:社区
citystring
cityCodestring市级code
areastring区县
areaCodestring区县级code
streetstring街道
streetCodestring街道级code
communitystring社区
communityCodestring社区级code
orgIdstring--
deptIdstring--

3. getClientInfo

import * as ruralApp from "rural-sdk";

ruralApp.getClientInfo({
  success(res) {
    console.log("getClientInfo:", res);
  }
})

返回值

object

类型说明
tokenstring移动端token

4. getUserProfile

import * as ruralApp from "rural-sdk";

ruralApp.getUserProfile({
  success(res) {
    console.log("getUserProfile:", res);
  }
})

返回值

object

类型说明
namestring昵称
phonestring手机号
positionstring职位
avatarstring用户头像

5. chooseImage

import * as ruralApp from "rural-sdk";

ruralApp.chooseImage({
  count: 1, // 默认9
  sizeType: ['original', 'compressed'], // 可以指定是原图还是压缩图,默认二者都有
  sourceType: ['album', 'camera'], // 可以指定来源是相册还是相机,默认二者都有
  quality: 0.8, //压缩质量,范围0~1,数值越小,质量越低,压缩率越高(仅对jpg有效)
  success(res) {
    let list = res.fileList;
    console.log("list:", list);
  }
})

返回值

Array

类型说明
fileListArrayFile对象数组

6. setTitle

import * as ruralApp from "rural-sdk";

ruralApp.setTitle({title: "我是新的标题"})

7. openWebView

import * as ruralApp from "rural-sdk";

ruralApp.openWebView({title: "测试地址", url: "https://m.baidu.com/"});

8. closeWebView

import * as ruralApp from "rural-sdk";

ruralApp.closeWebView();

9. getLocation

import * as ruralApp from "rural-sdk";

ruralApp.getLocation({
  success(res) {
    var latitude = res.latitude; // 纬度,浮点数,范围为90 ~ -90
    var longitude = res.longitude; // 经度,浮点数,范围为180 ~ -180。
    var speed = res.speed; // 速度,以米/每秒计
    var accuracy = res.accuracy; // 位置精度
  }
})

10. showLoading

import * as ruralApp from "rural-sdk";

ruralApp.showLoading();

11. hideLoading

import * as ruralApp from "rural-sdk";

ruralApp.hideLoading();

12. scanQRCode

import * as ruralApp from "rural-sdk";

ruralApp.scanQRCode({
  success(res) {
    // 回调
  }
})

13. getUserId

4.7.x 以上版本支持

import * as ruralApp from "rural-sdk";

ruralApp.getUserId({
  success(res) {
    // 回调
    console.log("userid:", res.userid)
  }
})

14. requestOCR

4.8.x 以上版本支持

ocrType:IDCardOCR(身份证识别)、BankCardOCR(银行卡识别)、BizLicenseOCR(营业执照识别)、DriverLicenseOCR(驾驶证识别)、LicensePlateOCR(车牌识别)、VehicleLicenseOCR(行驶证识别)、VatInvoiceOCR(增值税发票识别)、GeneralBasicOCR(通用印刷体shibie)

import * as ruralApp from "rural-sdk";

ruralApp.requestOCR({
  sourceType: ['camera','album'],   // 可以指定图片来源是相册还是相机,默认二者都有
  ocrType: 'IDCardOCR',             // ocr识别类型
  title: 'title',                   // 识别页面标题
  success(res) {
    // 回调
    var ocrResult = res.ocrResult;
    console.log('res: %o', ocrResult); //日志打印
  }
})

15. inject

4.9.0 以上版本支持

调用shell-app里apiName方法

注意:apiName方法必须在shell-app里实现

import { inject } from "rural-sdk";

inject('navigateToMiniProgram', {
appId: 'wxf09c0e08ffee7711',
path: 'pages/login/index'
});

三、本地调试

设置调试模式(本地调试时调用该方法,调用该方法会覆盖宿主传递过来的参数)

import { setMockInfo } from "rural-sdk";

setMockInfo({
  user: {
    name: "张三",
    phone: "18612345678",
    position: "--",
    avatar: ""
  },
  levelInfo: {
    type: 10,
    city: "济南市",
    cityCode: '370100'
  }
});

示例DEMO下载

更新日志

更新记录

4.9.3

4 months ago

4.9.0

4 months ago

4.9.2

4 months ago

4.9.1

4 months ago

5.0.7

8 months ago

5.0.6

9 months ago

5.0.5

9 months ago

5.0.4

10 months ago

5.0.3

10 months ago

5.0.2

10 months ago

5.0.1

10 months ago

5.0.0

10 months ago

4.8.0

1 year ago

4.7.0

1 year ago

4.6.0

2 years ago

4.5.0

2 years ago

4.4.0

2 years ago

4.3.0

2 years ago

4.1.0

2 years ago

4.0.1

2 years ago

4.0.3

2 years ago

4.2.0

2 years ago

4.0.2

2 years ago

4.0.0

2 years ago

3.1.0

3 years ago

3.0.1

3 years ago

3.0.0

3 years ago

2.1.2

3 years ago

2.2.0

3 years ago

2.1.1

3 years ago

2.1.0

3 years ago

2.0.3

3 years ago

2.0.2

3 years ago

2.0.1

3 years ago

2.0.0

3 years ago

1.0.3

3 years ago

1.0.2

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago