基础功能
获取登录用户的授权信息
ulife.getUserInfo(Object)
用户登录后可获取用户信息,在用户未授权过的情况下调用此接口,将不再出现授权弹窗,会直接进入 fail 回调。在用户已授权的情况下调用此接口,可成功获取用户信息。
入参Object
名称 | 类型 | 是否必填 | 描述 | 默认值 | 最低版本 |
---|---|---|---|---|---|
authorization_code | Function | 否 | 授权代码 | - | - |
success | Function | 否 | 调用成功的回调函数 | - | - |
fail | Function | 否 | 调用失败的回调函数 | - | - |
complete | Function | 否 | 调用结束的回调函数(调用成功、失败都会执行) | - | - |
success 返回值
名称 | 类型 | 必须 | 描述 |
---|---|---|---|
userInfo | Object | 是 | - |
nickName | String | 是 | 昵称 |
avatarUrl | String | 否 | 头像 |
gender | Number | 是 | 1:男;0:女;-1:未知 |
手机号、昵称、头像、性别、生日、职业、婚否、生育史。。。
fail 返回值
名称 | 类型 | 必须 | 描述 |
---|---|---|---|
errorMsg | String | 是 | 错误描述 |
errorCode | Number | 是 | 错误码 |
类型推断:
类型注释:
代码示例
// 必须是在用户已经授权的情况下调用
ulife.getUserInfo({
success: res => console.log(res),
fail: res => console.log(res)
});
检查登录状态
ulife.checkSession(Object)
检查登录是否过期,用户通过ulife.getAuth登录有时效性
入参Object
名称 | 类型 | 是否必填 | 描述 | 默认值 | 最低版本 |
---|---|---|---|---|---|
success | Function | 否 | 调用成功的回调函数 | - | - |
fail | Function | 否 | 调用失败的回调函数 | - | - |
complete | Function | 否 | 调用结束的回调函数(调用成功、失败都会执行) | - | - |
success 返回值
名称 | 类型 | 必须 | 描述 |
---|---|---|---|
- | - | - | - |
fail 返回值
名称 | 类型 | 必须 | 描述 |
---|---|---|---|
errorMsg | String | 是 | 错误描述 |
errorCode | Number | 是 | 错误码 |
类型推断:
类型注释:
代码示例
优健康生活登录
ulife.getLogin(Object)
入参Object
名称 | 类型 | 是否必填 | 描述 | 默认值 | 最低版本 |
---|---|---|---|---|---|
success | Function | 否 | 调用成功的回调函数 | - | - |
fail | Function | 否 | 调用失败的回调函数 | - | - |
complete | Function | 否 | 调用结束的回调函数(调用成功、失败都会执行) | - | - |
success 返回值
名称 | 类型 | 必须 | 描述 |
---|---|---|---|
authCode | String | 是 | 授权码 |
fail 返回值
名称 | 类型 | 必须 | 描述 |
---|---|---|---|
errorMsg | String | 是 | 错误描述 |
errorCode | Number | 是 | 错误码 |
类型推断:
类型注释:
代码示例
优健康生活内部分享
ulife.share(Object) 🎉
入参Object
名称 | 类型 | 是否必填 | 描述 | 默认值 | 最低版本 |
---|---|---|---|---|---|
description | String | 是 | 描述内容,限制长度不超过64; | - | - |
image | String | 是 | - | - | |
title | String | 是 | 消息标题,限制长度不超过32; | - | - |
url | String | 是 | 分享的链接 | - | - |
platformType | String | 否 | 分享的平台类型 'WeChat', 'WechatMoments', 'QQ', 'QQSpace', 'Weibo', | 不传参时,默认展示分享面板 | - |
success | Function | 否 | 调用成功的回调函数 | - | - |
fail | Function | 否 | 调用失败的回调函数 | - | - |
complete | Function | 否 | 调用结束的回调函数, 调用成功、失败都会执行 | - | - |
success 返回值
名称 | 类型 | 必须 | 描述 |
---|---|---|---|
- | - | - | - |
fail 返回值
名称 | 类型 | 必须 | 描述 |
---|---|---|---|
errorMsg | String | 是 | 错误描述 |
errorCode | Number | 是 | 错误码 |
类型推断:
类型注释:
代码示例
ulife.share({
title: '微信用户分享-分享标题',
description: '微信用户分享 - description',
image: 'http://k.zol-img.com.cn/sjbbs/7692/a7691515_s.jpg',
url: 'https://nervjs.github.io/taro/docs/components/media/image.html',
platformType: 'WeChat',
success: () => {
console.log('微信用户分享,客户端已收到通知');
},
fail: res => console.log(res)
});
刷新页面
ulife.refresh(Object)
主动刷新功能
入参Object
名称 | 类型 | 是否必填 | 描述 | 默认值 | 最低版本 |
---|---|---|---|---|---|
success | Function | 否 | 调用成功的回调函数 | - | - |
fail | Function | 否 | 调用失败的回调函数 | - | - |
complete | Function | 否 | 调用结束的回调函数(调用成功、失败都会执行) | - | - |
success 返回值
名称 | 类型 | 必须 | 描述 |
---|---|---|---|
- | - | - | - |
fail 返回值
名称 | 类型 | 必须 | 描述 |
---|---|---|---|
errorMsg | String | 是 | 错误描述 |
errorCode | Number | 是 | 错误码 |
类型推断:
类型注释:
代码示例
导航栏设置
ulife.setNavigationBar(Object)
主动刷新功能
入参Object
颜色(非必填,6位色值)、透明度(非必填,百分比)、标题(非必填,最多8个字)、返回键(非必填,是否展示;未配置链接且没有上一级跳转则不展示)、返回链接(非必填,点击返回跳转的链接;未配置则返回上一级)
名称 | 类型 | 是否必填 | 描述 | 默认值 | 最低版本 |
---|---|---|---|---|---|
success | Function | 否 | 调用成功的回调函数 | - | - |
fail | Function | 否 | 调用失败的回调函数 | - | - |
complete | Function | 否 | 调用结束的回调函数(调用成功、失败都会执行) | - | - |
success 返回值
名称 | 类型 | 必须 | 描述 |
---|---|---|---|
- | - | - | - |
fail 返回值
名称 | 类型 | 必须 | 描述 |
---|---|---|---|
errorMsg | String | 是 | 错误描述 |
errorCode | Number | 是 | 错误码 |
类型推断:
类型注释:
代码示例
通用的网络请求
ulife.commonRequest(Object)
允许小程序在客户端内发送一个服务端定义网络请求,App端会自动添加一些验签和排序,用户无需关心。服务端正常业务(code=200)返回,会走sucess,其余任何错误都会走fail。
具体后台接口,请参照Wiki,注意需要VPN链接杭州。
入参Object
名称 | 类型 | 是否必填 | 描述 | 默认值 | 最低版本 |
---|---|---|---|---|---|
url | String | 是 | 请求接口url,不能为空,具体值参照Wiki->接口类型->请求url定义,,结构:模块名/子模块/.../方法名。如获取报告列表:report/getReportList" 注意最前方不需要带\ | - | - |
params | Object | 否 | 请求接口参数,如:{"idCardNumber":"413026xxxxxx","phoneNumber":"15225222222"}。必须是键值对。不需要传入公共参数,App端自己会处理。 | - | - |
success | Function | 否 | 调用成功的回调函数 | - | - |
fail | Function | 否 | 调用失败的回调函数 | - | - |
complete | Function | 否 | 调用结束的回调函数(调用成功、失败都会执行) | - | - |
success 返回值
当服务端返回code=200的时候,success中直接取返回结果,这个结果就是服务端响应参数的data字段里面的值。
名称 | 类型 | 必须 | 描述 |
---|---|---|---|
- | - | - | - |
fail 返回值
当服务端返回code不等于200或其他任何错误都是这个回调。
名称 | 类型 | 必须 | 描述 |
---|---|---|---|
errorMsg | String | 是 | 错误描述 |
errorCode | Number | 是 | 错误码 |
类型推断:
类型注释:
代码示例
ulife.commonRequest({
url:'hSetting/getReportPushList',
params:{"pageIndex":1, 'pageSize': 20},
success: (res) =>{
console.log('成功', res);
},
fail: (res) =>{
console.log('失败', res)
},
complete: (res) =>{
console.log('完成', res)
},
});