class AuthenticateResult
cangjie
public open class AuthenticateResult功能:表示身份验证操作的结果。
成员概览
| 成员 | 功能 |
|---|---|
| prop succeeded | 返回身份验证是否成功。 |
| prop principal | 返回身份验证得到的用户主体。 |
| func fail(String) | 使用失败消息创建身份验证失败结果。 |
| func fail(Exception) | 使用异常创建身份验证失败结果。 |
| func fail(Exception, AuthenticationProperties) | 使用异常和属性创建身份验证失败结果。 |
| func success(AuthenticationTicket) | 使用票据创建身份验证成功结果。 |
| func noResult() | 创建没有结果的身份验证结果。 |
prop succeeded
cangjie
public prop succeeded: Bool功能:返回身份验证是否成功。
类型:Bool
prop principal
cangjie
public prop principal: ?ClaimsPrincipal功能:返回身份验证得到的用户主体。
类型:?ClaimsPrincipal
func fail(String)
cangjie
public static func fail(failureMessage: String): AuthenticateResult功能:使用失败消息创建身份验证失败结果。
参数:
- failureMessage:
String- 失败消息。
返回值:
- AuthenticateResult - 失败的身份验证结果。
func fail(Exception)
cangjie
public static func fail(failure: Exception): AuthenticateResult功能:使用异常创建身份验证失败结果。
参数:
- failure:
Exception- 失败异常。
返回值:
- AuthenticateResult - 失败的身份验证结果。
func fail(Exception, AuthenticationProperties)
cangjie
public static func fail(failure: Exception, properties: AuthenticationProperties): AuthenticateResult功能:使用异常和属性创建身份验证失败结果。
参数:
- failure:
Exception- 失败异常。 - properties: AuthenticationProperties - 附带的身份验证属性。
返回值:
- AuthenticateResult - 失败的身份验证结果。
func success(AuthenticationTicket)
cangjie
public static func success(ticket: AuthenticationTicket): AuthenticateResult功能:使用票据创建身份验证成功结果。
参数:
- ticket: AuthenticationTicket - 身份验证票据。
返回值:
- AuthenticateResult - 成功的身份验证结果。
func noResult()
cangjie
public static func noResult(): AuthenticateResult功能:创建没有结果的身份验证结果。
返回值:
- AuthenticateResult - 无结果的身份验证结果。