tt.authorize
基础库版本 1.3.0 开始支持本方法
提前向用户发出授权请求。该方法不会调用对应接口,只会弹框咨询用户是否授权或者获取用户信息。如果用户之前有授权,该接口直接返回成功,不会跟用户产生交互。
语法
tt.authorize(options);
参数
options
为 object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|---|
scope | string | 是 | 需要预授权的 scope,详见 用户授权 scope 说明 | 1.3.0 | |
success | function | 否 | 接口调用成功的回调函数 | 1.3.0 | |
fail | function | 否 | 接口调用失败的回调函数 | 1.3.0 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 1.3.0 |
回调成功
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "authorize:ok" | 1.13.0 |
data | object | 授权结果,详情见 data 说明 | 1.13.0 |
data 说明
data 是申请的授权结果,其中 key 为入参的 scope,value 为授权结果,如:
data: {
"scope.userInfo": "ok"
}
回调失败
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "authorize:fail" + 详细错误信息 | 1.3.0 |
errNo | string | 错误码 | 1.20.0 |
扫码体验
请使用字节宿主APP扫码
代码示例
tt.authorize({
scope: "scope.userInfo",
success() {
// 用户同意授权用户信息
},
});
Bug & Tip
- Tip: 获取用户信息授权(scope.userInfo)前需要先调用
tt.login
,否则会出现"authroize:fail invalid session"报错。
点击纠错
该文档是否对你的开发有所帮助?
有帮助
没帮助
该文档是否对你的开发有所帮助?
有帮助
没帮助