Spire 天擎

外观

class CookieOptions ​

cangjie
public class CookieOptions

功能：表示写入响应 Cookie 时使用的选项。

成员概览 ​

成员功能
init(?String, ?String, ?DateTime, Bool, CookieSameSiteMode, Bool, ?Duration, Bool, Array<String>)使用显式选项值创建 Cookie 选项实例。
init(CookieOptions)使用现有 Cookie 选项创建副本。
var domain指定 Cookie 生效的域名。
var path指定 Cookie 生效的路径。
var expires指定 Cookie 的过期时间。
var secure指示是否仅通过安全连接发送 Cookie。
var sameSite指定 Cookie 的 SameSite 模式。
var httpOnly指示 Cookie 是否仅允许 HTTP 访问。
var maxAge指定 Cookie 的最大生存时长。
var isEssential指示 Cookie 是否为必需项。
var extensions保存额外的 Cookie 扩展属性。
func createCookieHeaderValue(String)根据名称创建 Cookie 头值。
func createCookieHeaderValue(String, ?String)根据名称和值创建 Cookie 头值。

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

cangjie
public init(domain!: ?String = None, path!: ?String = '/', expires!: ?DateTime = 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 生效路径。
  • expires: ?DateTime - Cookie 过期时间。
  • secure: Bool - 是否仅通过安全连接发送。
  • sameSite: CookieSameSiteMode - Cookie 的 SameSite 模式。
  • httpOnly: Bool - 是否仅允许 HTTP 访问。
  • maxAge: ?Duration - Cookie 最大生存时长。
  • isEssential: Bool - 是否为必需项。
  • extensions: Array<String> - 附加扩展属性集合。

init(CookieOptions) ​

cangjie
public init(options: CookieOptions)

功能：使用现有 Cookie 选项创建副本。

参数：

var domain ​

cangjie
public var domain: ?String = None

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

类型：?String

var path ​

cangjie
public var path: ?String = '/'

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

类型：?String

var expires ​

cangjie
public var expires: ?DateTime = None

功能：指定 Cookie 的过期时间。

类型：?DateTime

var secure ​

cangjie
public var secure: Bool = false

功能：指示是否仅通过安全连接发送 Cookie。

类型：Bool

var sameSite ​

cangjie
public var sameSite: CookieSameSiteMode = CookieSameSiteMode.None

功能：指定 Cookie 的 SameSite 模式。

类型：CookieSameSiteMode

var httpOnly ​

cangjie
public var httpOnly: Bool = false

功能：指示 Cookie 是否仅允许 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> = []

功能：保存额外的 Cookie 扩展属性。

类型：Array<String>

func createCookieHeaderValue(String) ​

cangjie
public func createCookieHeaderValue(name: String): String

功能：根据名称创建 Cookie 头值。

参数：

  • name: String - Cookie 名称。

返回值：

  • String - 生成后的 Cookie 头值。

func createCookieHeaderValue(String, ?String) ​

cangjie
public func createCookieHeaderValue(name: String, value: ?String): String

功能：根据名称和值创建 Cookie 头值。

参数：

  • name: String - Cookie 名称。
  • value: ?String - Cookie 值。

返回值：

  • String - 生成后的 Cookie 头值。