tt.login
收藏我的收藏
基础库 1.0.0 开始支持本方法,这是一个异步方法。
调用该 API 可以获取用户临时的登录凭证。
| 前提条件 | 无 |
| 业务背景 | 无 |
| 使用限制 | 无 |
| 注意事项 |
|
| 相关教程 | 无 |
语法
tt.login(options)
参数说明
options 为 object 类型,属性如下:
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| force | boolean | true | 否 | 未登录时, 是否强制调起登录框 | 1.0.0 |
| success | function | 否 | 接口调用成功的回调函数 | 1.0.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.0.0 | |
| complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 1.0.0 |
回调成功
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| anonymousCode | string | 用于标识当前设备, 无论登录与否都会返回, 有效期 3 分钟。 | 1.0.0 |
| isLogin | boolean | 判断在当前 APP(头条、抖音等)是否处于登录状态。 | 1.0.0 |
| code | string | 临时登录凭证, 有效期 3 分钟。开发者可以通过在服务器端调用登录凭证校验接口换取 openid 和 session_key 等信息。 | 1.0.0 |
| errMsg | string | "login:ok" | 1.0.0 |
回调失败
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "login:fail " + 详细错误信息 | 1.0.0 |
错误码
| errNo | errMsg | 说明 | 最低支持版本 |
|---|---|---|---|
| 10401 | getHostSessionFail | 小游戏框架内部错误,有需要请创建工单咨询 | 1.0.0 |
| 10501 | app in background | 1.0.0 | |
| 10301 | feature is not supported in app | 1.0.0 | |
| 20000 | internal error | 小游戏框架内部错误,有需要请创建工单咨询 | 1.0.0 |
| 21101 | login is in progress, please do not call again | 1.0.0 | |
| 10401 | Internal error: login failed | 小游戏框架内部错误,有需要请创建工单咨询 | 1.0.0 |
| 10401 | Internal error: service error xxx | 小游戏框架内部错误,有需要请创建工单咨询 | 1.0.0 |
扫码体验
请使用字节宿主APP扫码
代码示例
tt.login({ force: true, success(res) { console.log(`login 调用成功${res.code} ${res.anonymousCode}`); }, fail(res) { console.log(`login 调用失败`); }, });
