rural-sdk v4.9.3
Rural SDK
一、Usage
获取宿主信息。
二、SDK API
1. getUserInfo
获取用户信息
import { getUserInfo } from "rural-sdk";
const info = getUserInfo();
返回值
object
值 | 类型 | 说明 |
---|---|---|
name | string | 用户名 |
phone | string | 手机号 |
2. getLevelInfo
获取账号类型信息;
import { getLevelInfo } from "rural-sdk";
const info = getLevelInfo();
返回值
object
值 | 类型 | 说明 |
---|---|---|
type | string | //10:市, 0:区, 1:街道, 2:社区 |
city | string | 市 |
cityCode | string | 市级code |
area | string | 区县 |
areaCode | string | 区县级code |
street | string | 街道 |
streetCode | string | 街道级code |
community | string | 社区 |
communityCode | string | 社区级code |
2.1 getLevelInfoRow
获取账号类型信息(返回原始信息);
import { getLevelInfo } from "rural-sdk";
const info = getLevelInfo();
返回值
object
值 | 类型 | 说明 |
---|---|---|
type | string | //10:市, 0:区, 1:街道, 2:社区 |
city | string | 市 |
cityCode | string | 市级code |
area | string | 区县 |
areaCode | string | 区县级code |
street | string | 街道 |
streetCode | string | 街道级code |
community | string | 社区 |
communityCode | string | 社区级code |
orgId | string | -- |
deptId | string | -- |
3. getClientInfo
import * as ruralApp from "rural-sdk";
ruralApp.getClientInfo({
success(res) {
console.log("getClientInfo:", res);
}
})
返回值
object
值 | 类型 | 说明 |
---|---|---|
token | string | 移动端token |
4. getUserProfile
import * as ruralApp from "rural-sdk";
ruralApp.getUserProfile({
success(res) {
console.log("getUserProfile:", res);
}
})
返回值
object
值 | 类型 | 说明 |
---|---|---|
name | string | 昵称 |
phone | string | 手机号 |
position | string | 职位 |
avatar | string | 用户头像 |
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
值 | 类型 | 说明 |
---|---|---|
fileList | Array | File对象数组 |
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'
}
});
更新日志
4 months ago
4 months ago
4 months ago
4 months ago
8 months ago
9 months ago
9 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago