tt.login
基础库 1.0.0 开始支持本方法，这是一个异步方法。
调用该 API 可以获取用户临时的登录凭证。
语法
tt.login(options)参数说明
options 为 object 类型，属性如下：
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| force | boolean | true | 否 | 未登录时, 是否强制调起登录框 | 1.0.0 |
| success | function | 否 | 接口调用成功的回调函数 | 1.0.0 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | 1.0.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.0.0 |
回调成功
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "login:ok" | 1.0.0 |
| code | string | 临时登录凭证, 有效期 5 分钟。开发者可以通过在服务端调用 登录凭证校验接口 换取 openid 和 session_key 等信息。 | 1.0.0 |
| anonymousCode | string | 用于标识当前设备, 无论登录与否都会返回, 有效期 5 分钟。 | 1.0.0 |
| isLogin | boolean | 判断在当前 APP（头条、抖音等）是否处于登录状态。 | 1.0.0 |
回调失败
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "login:fail " + 详细错误信息 | 1.0.0 |
详细错误信息说明
| errMsg | 说明 |
|---|---|
| login:fail network unavailable | 网络不可用 |
| login:fail feature is not supported in app | 当前宿主不支持 |
| login:fail service error:${errMsg},errCode=${errNo} | 服务端错误 |
| login:fail app in background | 当前处于后台 |
| login:fail host login fail | 宿主登录失败 |
扫码体验
请使用字节宿主APP扫码
代码示例
tt.login({
force: true,
success(res) {
console.log(`login 调用成功${res.code} ${res.anonymousCode}`);
},
fail(res) {
console.log(`login 调用失败`);
},
});Bug & Tip
- Tip：
force为true时(默认值为true), 如果用户未在宿主登录(例如未在头条 App 登录), 则会调起宿主的登录窗口, 如果用户点击取消则会回调fail； - Tip：只有宿主登录的用户
success才有code, 否则只有anonymousCode； - Tip：
code可以换取openid、unionid,openid是用户在当前小程序的 ID，unionid是用户在小程序平台的唯一标识符，如果开发者拥有多个小程序，可通过 unionid 来区分用户的唯一性； - Tip：
anonymousCode可以换取anonymous_openid, 同一台手机anonymous_openid是不同的。
点击纠错
该文档是否对你的开发有所帮助？
有帮助
没帮助
该文档是否对你的开发有所帮助？
有帮助
没帮助