- JS API 列表
- 基础
- 网络
- 媒体
- 地图
- 文件
- 开放接口
- 数据缓存
- 地理位置
- 设备
- 画布
- 界面
- 页面导航
- 侧边栏能力
- 行业开放
- AI/AR能力
- 第三方平台
- TTML
- 转发和挂载
- 其它
- 直播能力
tt.getUserProfile收藏我的收藏
收藏
我的收藏基础库 2.30.0 开始支持本方法,低版本需做兼容处理,这是一个异步方法。
获取用户的基本信息,只可在 tap 事件回调中调用,每次调用都会弹出授权提示窗,若用户同意,则会返回用户的真实数据。
前提条件 | 无 |
业务背景 | 无 |
使用限制 | 无 |
注意事项 |
|
支持沙盒 | 否 |
相关教程 | 无 |
语法
tt.getUserProfile(options)
参数说明
options 为 object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|---|
force | boolean | false | 否 | 当宿主未登录时,是否强制拉起登录框 | 2.54.0 |
success | function | 否 | 接口调用成功的回调函数 | 2.30.0 | |
fail | function | 否 | 接口调用失败的回调函数 | 2.30.0 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 2.30.0 |
回调成功
object 类型,属性如下:
encryptedData 参数说明
解密后的数据为object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
avatarUrl | string | 用户头像网络地址 | 2.30.0 |
nickName | string | 用户昵称 | 2.30.0 |
gender | number | 用户性别,0: 未知;1:男性;2:女性 | 2.30.0 |
city | string | 用户所在城市 | 2.30.0 |
province | string | 用户所在省份 | 2.30.0 |
country | string | 用户所在国家 | 2.30.0 |
language | string | 用户语言,目前为空 | 2.30.0 |
watermark | Watermark | 敏感数据水印 | 2.30.0 |
Watermark 类型说明
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
appid | string | 数据源小程序 id | 2.30.0 |
timestamp | number | 时间戳,可以用于检查数据的时效性 | 2.30.0 |
userInfo 类型说明
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
avatarUrl | string | 用户头像 | 2.30.0 |
nickName | string | 用户昵称 | 2.30.0 |
gender | number | 用户性别,0: 未知;1:男性;2:女性 | 2.30.0 |
city | string | 用户城市 | 2.30.0 |
province | string | 用户省份 | 2.30.0 |
country | string | 用户国家 | 2.30.0 |
language | string | 用户语言,目前为空 | 2.30.0 |
回调失败
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "getUserProfile:fail" + 详细错误信息 | 2.30.0 |
错误码
errorCode | errMsg | errorType | 说明 | 最低支持版本 |
---|---|---|---|---|
111687 | feature is not supported in app `{isLogin | userId | appId}` | D | 协议未实现 | 2.30.0 |
111696 | not login | D | 未登录 | 2.30.0 |
111698 | invalid session | D | 没有登录态信息 | 2.30.0 |
111685 | network unavailable | U | 用户无网络 | 2.30.0 |
111679 | api scope is not declared in the privacy agreement | D | 需要隐私协议授权,但后台未配置该隐私数据 | 2.30.0 |
111690 | auth deny | U | 用户手动拒绝授权 | 2.30.0 |
111691 | service error | F | 小程序框架内部错误,有需要请拉客服咨询 | 2.30.0 |
111601 | must be invoked by user tap gesture | D | 必须在用户点击的事件回调中触发 | 2.30.0 |
111680 | privacy permission is not authorized | U | 隐私协议授权被用户拒绝 | 2.30.0 |
111691 | Internal error: get host user info fail | F | 小程序框架内部错误,有需要请拉客服咨询 | 2.30.0 |
111691 | Internal error server error ${msg} | F | 小程序框架内部错误,有需要请拉客服咨询 | 2.30.0 |
扫码体验
请使用字节宿主APP扫码
代码示例
tt.getUserProfile({
success(res) {
console.log("getUserProfile 调用成功:", res.userInfo);
},
fail(res) {
console.log("getUserProfile 调用失败", res);
},
});
该文档是否有帮助?
点击纠错