阅读(3485)
赞(9)
tt.getUserInfo
2020-02-12 17:00:21 更新
获取已登录用户的基本信息或特殊信息
提示
本 API 需要用户授权方可调用，详细信息可参考用户授权
本 API 依赖于 login，请确保调用前已经调用了该 API
输入
object 类型，属性如下：
| 属性 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
success | function | 否 | 接口调用成功的回调函数 | 1.0.0 | |
complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | 1.0.0 | |
fail | function | 否 | 接口调用失败的回调函数 | 1.0.0 | |
withCredentials | boolean | false | 否 | 是否需要返回敏感数据 | 1.0.0 |
success 返回参数说明
object 类型，属性如下：
| 属性 | 类型 | 说明 |
|---|---|---|
userInfo | object | 用户信息 |
userInfo.avatarUrl | string | 用户头像 |
userInfo.nickName | string | 用户名 |
userInfo.gender | number | 用户性别，0: 未知；1:男性；2:女性 |
userInfo.city | string | 用户城市 |
userInfo.province | string | 用户省份 |
userInfo.country | string | 用户国家 |
userInfo.language | string | 用户语言，目前为空 |
rawData | string | userInfo 的 JSON 字符串形式 |
如果输入中传递了 withCredentials:true，返回对象参数会增加如下扩展属性：
| 属性 | 类型 | 说明 |
|---|---|---|
signature | string | 用于校验用户信息是否被篡改，请参考文档 |
encryptedData | string | 包括敏感信息（如 openId）在内的已加密用户数据，如需解密数据请参考文档 |
iv | string | 加密算法参数 |
encryptedData 解密后可以获得：
| 属性 | 类型 | 说明 |
|---|---|---|
watermark | object | 敏感数据水印 |
watermark.appid | string | 数据源小程序 id |
watermark.timestamp | number | 时间戳，可以用于检查数据的时效性 |
代码示例
tt.getUserInfo({
success(res) {
console.log(`getUserInfo 调用成功 ${res.userInfo}`);
},
fail(res) {
console.log(`getUserInfo 调用失败`);
}
});