Spire 天擎

外观

class CookieBuilder ​

cangjie
public class CookieBuilder

功能：提供按上下文构建 Cookie 选项的能力。

成员概览 ​

成员功能
init(?String, ?String, ?Duration, Bool, CookieSameSiteMode, Bool, ?Duration, Bool, Array<String>)使用显式选项值创建 Cookie 构建器。
var name指定要构建的 Cookie 名称。
var domain指定 Cookie 生效的域名。
var path指定 Cookie 生效的路径。
var expiration指定 Cookie 相对当前时间的过期时长。
var secure指示是否启用安全传输。
var httpOnly指示是否仅允许 HTTP 访问。
var maxAge指定 Cookie 最大生存时长。
var isEssential指示 Cookie 是否为必需项。
var extensions保存附加扩展属性。
var sameSite指定 Cookie 的 SameSite 模式。
var securePolicy指定安全传输策略。
func build(HttpContext)基于当前时间构建 Cookie 选项。
func build(HttpContext, DateTime)基于指定时间构建 Cookie 选项。

init(?String, ?String, ?Duration, Bool, CookieSameSiteMode, Bool, ?Duration, Bool, Array<String>) ​

cangjie
public init(domain!: ?String = None, path!: ?String = '/', expiration!: ?Duration = None, secure!: Bool = false,
sameSite!: CookieSameSiteMode = CookieSameSiteMode.None, httpOnly!: Bool = false, maxAge!: ?Duration = None,
isEssential!: Bool = false, extensions!: Array<String> = [])

功能：使用显式选项值创建 Cookie 构建器。

参数：

  • domain: ?String - Cookie 生效域名。
  • path: ?String - Cookie 生效路径。
  • expiration: ?Duration - Cookie 相对过期时长。
  • secure: Bool - 是否启用安全传输。
  • sameSite: CookieSameSiteMode - Cookie 的 SameSite 模式。
  • httpOnly: Bool - 是否仅允许 HTTP 访问。
  • maxAge: ?Duration - Cookie 最大生存时长。
  • isEssential: Bool - 是否为必需项。
  • extensions: Array<String> - 附加扩展属性集合。

var name ​

cangjie
public var name: ?String = None

功能：指定要构建的 Cookie 名称。

类型：?String

var domain ​

cangjie
public var domain: ?String = None

功能：指定 Cookie 生效的域名。

类型：?String

var path ​

cangjie
public var path: ?String = '/'

功能：指定 Cookie 生效的路径。

类型：?String

var expiration ​

cangjie
public var expiration: ?Duration = None

功能：指定 Cookie 相对当前时间的过期时长。

类型：?Duration

var secure ​

cangjie
public var secure: Bool = false

功能：指示是否启用安全传输。

类型：Bool

var httpOnly ​

cangjie
public var httpOnly: Bool = false

功能：指示是否仅允许 HTTP 访问。

类型：Bool

var maxAge ​

cangjie
public var maxAge: ?Duration = None

功能：指定 Cookie 最大生存时长。

类型：?Duration

var isEssential ​

cangjie
public var isEssential: Bool = false

功能：指示 Cookie 是否为必需项。

类型：Bool

var extensions ​

cangjie
public var extensions: Array<String> = []

功能：保存附加扩展属性。

类型：Array<String>

var sameSite ​

cangjie
public var sameSite = CookieSameSiteMode.None

功能：指定 Cookie 的 SameSite 模式。

var securePolicy ​

cangjie
public var securePolicy = CookieSecurePolicy.None

功能：指定安全传输策略。

func build(HttpContext) ​

cangjie
public func build(context: HttpContext): CookieOptions

功能：基于当前时间构建 Cookie 选项。

参数：

返回值：

func build(HttpContext, DateTime) ​

cangjie
public func build(context: HttpContext, expiresFrom: DateTime): CookieOptions

功能：基于指定时间构建 Cookie 选项。

参数：

  • context: HttpContext - 当前 HTTP 上下文。
  • expiresFrom: DateTime - 计算绝对过期时间的基准时间。

返回值：