开发
API

tt.login

基础库 1.0.0 开始支持本方法,这是一个异步方法。

调用该 API 可以获取用户临时的登录凭证。

语法

tt.login(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
forcebooleantrue未登录时, 是否强制调起登录框1.0.0
successfunction接口调用成功的回调函数1.0.0
completefunction接口调用结束的回调函数(调用成功、失败都会执行)1.0.0
failfunction接口调用失败的回调函数1.0.0

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring"login:ok"1.0.0
codestring临时登录凭证, 有效期 5 分钟。开发者可以通过在服务端调用 登录凭证校验接口 换取 openid 和 session_key 等信息。1.0.0
anonymousCodestring用于标识当前设备, 无论登录与否都会返回, 有效期 5 分钟。1.0.0
isLoginboolean判断在当前 APP(头条、抖音等)是否处于登录状态。1.0.0

回调失败

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring"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:forcetrue 时(默认值为 true), 如果用户未在宿主登录(例如未在头条 App 登录), 则会调起宿主的登录窗口, 如果用户点击取消则会回调 fail
  • Tip:只有宿主登录的用户 success 才有 code, 否则只有 anonymousCode
  • Tip:code 可以换取 openidunionid, openid 是用户在当前小程序的 ID,unionid 是用户在小程序平台的唯一标识符,如果开发者拥有多个小程序,可通过 unionid 来区分用户的唯一性;
  • Tip:anonymousCode 可以换取 anonymous_openid, 同一台手机 anonymous_openid 是不同的。
点击纠错
该文档是否对你的开发有所帮助?
有帮助
没帮助
该文档是否对你的开发有所帮助?
有帮助
没帮助