IAuthServiceLoginAsync Method

登录。

Definition

Namespace: QuickAdmin.Service.Auth
Assembly: QuickAdmin.Net (in QuickAdmin.Net.dll) Version: 2.0.13
C#
Task<IServiceResult<LoginOutput>> LoginAsync(
	LoginInput loginInput,
	bool doNotCheckCaptcha = false,
	CancellationToken cancellationToken = default
)

Parameters

loginInput  LoginInput
登录输入，其 LoginWay 只允许为 IdAndPwd 或 SmsCode。
doNotCheckCaptcha  bool  (Optional)
指示是否不检查验证码。
若传入 true，将忽略 EnableLoginCaptcha 和 EnableSmsCaptcha 配置，始终不去检查验证码。 传入 false 则根据配置决定是否检查验证码。
cancellationToken  CancellationToken  (Optional)
用于取消操作的令牌。

Return Value

TaskIServiceResultLoginOutput
Data 为登录输出的服务调用结果。

Remarks

doNotCheckCaptcha 传入 true 将忽略 EnableLoginCaptcha 和 EnableSmsCaptcha 配置，始终不去检查验证码。
在默认实现里，loginInput 的 LoginWay 只允许为 LoginWay.IdAndPwd 或 LoginWay.SmsCode。
若允许用户通过 手机号码+密码 或 邮箱地址+密码 的方式登录，loginInput.LoginWay 请传入 LoginWay.IdAndPwd，内部会自动去识别 loginInput.LoginId 为手机号码或邮箱地址并查找匹配用户。

See Also