title: Taro.login(option)

sidebar_label: login

调用接口获取登录凭证（code）。通过凭证进而换取用户登录态信息，包括用户的唯一标识（openid）及本次登录的会话密钥（session_key）等。用户数据的加解密通讯需要依赖会话密钥完成。更多使用方法详见 小程序登录。

支持情况：login - 图1 login - 图2 login - 图3

参考文档

类型

  1. (option?: Option) => Promise<SuccessCallbackResult>

参数

参数 类型
option Option

Option

参数 类型 必填 说明
complete (res: TaroGeneral.CallbackResult) => void 否 接口调用结束的回调函数（调用成功、失败都会执行）
fail (res: TaroGeneral.CallbackResult) => void 否 接口调用失败的回调函数
success (result: SuccessCallbackResult) => void 否 接口调用成功的回调函数
timeout number 否 超时时间，单位ms

SuccessCallbackResult

参数 类型 说明
code string 用户登录凭证（有效期五分钟）。开发者需要在开发者服务器后台调用 auth.code2Session，使用 code 换取 openid 和 session_key 等信息
errMsg string 调用结果

示例代码

  1. Taro.login({
  2.   success: function (res) {
  3.     if (res.code) {
  4.       //发起网络请求
  5.       Taro.request({
  6.         url: 'https://test.com/onLogin',
  7.         data: {
  8.           code: res.code
  9.         }
  10.       })
  11.     } else {
  12.       console.log('登录失败！' + res.errMsg)
  13.     }
  14.   }
  15. })