用户信息更新时间:2025-12-22 20:19:03
qg.getUserInfo
基础信息说明
功能概述:获取用户信息。调用时平台会弹出用户授权弹窗,若用户同意授权,则可获取到用户信息。
| 项目 | 说明 |
| 版本要求 | 无 |
| 前提条件 | 无 |
| 使用限制 | 无 |
| 相关教程 | 无 |
参数说明
qg.getUserInfo(option)
| 属性名 | 类型 | 默认值(如有) | 必填 | 说明 |
| success | Function | - | 否 | 成功回调 |
| fail | Function | - | 否 | 失败回调 |
| complete | Function | - | 否 | 完成回调 |
返回值说明
这是一个同步方法,无同步返回;通过回调异步返回。
回调结果说明
回调成功
返回对象包含 res.userInfo(用户信息对象)
userInfo 字段说明
| 参数名 | 类型 | 描述 |
| nickName | String | 用户昵称 |
| avatarUrl | String | 用户头像 url |
| gender | Int | 用户性别:0 未知,1 男,2 女 |
回调失败
| 参数名 | 类型 | 说明 |
| err | any | 用户拒绝授权或其他异常原因 |
触发与阶段说明
| 阶段 | 触发时机 | 说明 |
| 发起获取 | 调用 qg.getUserInfo | 透传到原生层;平台可能弹出授权弹窗 |
| 授权弹窗 | 平台弹窗 | 用户选择“允许/拒绝” |
| 成功回调 | 用户授权通过 | option.success(res),返回 res.userInfo |
| 失败回调 | 用户拒绝或异常 | option.fail(err),失败对象由底层定义 |
| 完成回调 | 成功或失败后 | option.complete(...),是否触发与入参内容以底层实现为准 |
示例代码
qg.getUserInfo({
success: function(res) {
console.log('res',res)
},
fail: function(){
console.log('user reject!')
},
complete: function(res){
console.log('get userInfo complete', res)
}
});注意事项
- 开发者调用时,平台会弹出用户授权弹窗,需要用户授权才能获取到用户信息,用户取消授权时会走失败回调,这时开发者需要处理用户取消授权的情况。
- 建议在登录成功并且服务端校验通过后调用
qg.onUserInfoChange / qg.offUserInfoChange
基础信息说明
功能概述:
- qg.onUserInfoChange(function callback):监听用户信息变化事件
- qg.offUserInfoChange(function callback):取消监听用户信息变化事件
| 项目 | 说明 |
| 版本要求 | 无 |
| 前提条件 | 先使用 qg.getUserInfo(option) 拉取当前用户信息(会弹出授权弹窗,成功返回 res.userInfo) |
| 使用限制 | 需用户授权后才会回调 |
| 相关教程 | 无 |
参数说明
qg.onUserInfoChange(function callback)
| 参数名 | 类型 | 默认值(如有) | 必填 | 说明 |
| callback | Function | - | 是 | 用户信息变化回调事件 |
qg.offUserInfoChange(function callback)
| 参数名 | 类型 | 默认值(如有) | 必填 | 说明 |
| callback | Function | - | 是 | 取消监听的同一回调引用 |
回调结果说明
callback(res):当用户信息更新时回调,包含 res.userInfo
userInfo 字段说明
| 参数名 | 类型 | 描述 |
| nickName | String | 用户昵称 |
| avatarUrl | String | 用户头像 url |
| gender | Int | 用户性别:0 未知,1 男,2 女 |
触发与阶段说明
| 阶段 | 触发时机 | 说明 |
| 初始化订阅 | 调用 qg.onUserInfoChange(cb) | - |
| 触发回调 | 用户信息变更后 | cb(res),包含 res.userInfo;仅在用户已授权的前提下触发 |
| 取消订阅 | 调用 qg.offUserInfoChange(cb) | 取消对应回调订阅,避免内存泄漏与无效回调 |
示例代码
// 订阅
function onChange(res) {
console.log(res.userInfo.nickName)
console.log(res.userInfo.avatarUrl)
console.log(res.userInfo.gender)
}
qg.onUserInfoChange(onChange)
// 取消订阅
qg.offUserInfoChange(onChange)注意事项
- 回调触发需要用户已同意授权,未授权不会回调
- 请使用同一函数引用进行取消订阅(即传入与订阅时相同的 callback)
上一篇:推荐
下一篇:登录
文档内容是否有帮助?
有帮助
无帮助