Spire 天擎

外观

class AuthenticationTicket ​

cangjie
public class AuthenticationTicket

功能：表示一次身份验证产生的票据。

成员概览 ​

成员功能
init(ClaimsPrincipal, String)使用默认属性创建身份验证票据。
init(ClaimsPrincipal, String, ?AuthenticationProperties)创建一个身份验证票据。
prop authenticationScheme返回票据所属方案名称。
prop principal返回票据关联的用户主体。
prop properties返回票据附带属性。
func serialize()将当前票据序列化为数据模型。
func deserialize(DataModel)从数据模型反序列化身份验证票据。

init(ClaimsPrincipal, String) ​

cangjie
public init(principal: ClaimsPrincipal, authenticationScheme: String)

功能：使用默认属性创建身份验证票据。

参数：

  • principal: ClaimsPrincipal - 用户主体。
  • authenticationScheme: String - 身份验证方案名称。

init(ClaimsPrincipal, String, ?AuthenticationProperties) ​

cangjie
public init(principal: ClaimsPrincipal, authenticationScheme: String, properties: ?AuthenticationProperties)

功能：创建一个身份验证票据。

参数：

prop authenticationScheme ​

cangjie
public prop authenticationScheme: String

功能：返回票据所属方案名称。

类型：String

prop principal ​

cangjie
public prop principal: ClaimsPrincipal

功能：返回票据关联的用户主体。

类型：ClaimsPrincipal

prop properties ​

cangjie
public prop properties: AuthenticationProperties

功能：返回票据附带属性。

类型：AuthenticationProperties

func serialize() ​

cangjie
public func serialize(): DataModelStruct

功能：将当前票据序列化为数据模型。

返回值：

  • DataModelStruct - 序列化后的数据模型。

func deserialize(DataModel) ​

cangjie
public static func deserialize(dm: DataModel): AuthenticationTicket

功能：从数据模型反序列化身份验证票据。

参数：

  • dm: DataModel - 输入的数据模型。

返回值：

异常：

  • DataModelException - 当输入数据不是对象结构时抛出。