ktor-server-core/io.ktor.sessions/CookieConfiguration

CookieConfiguration

class CookieConfiguration
Content copied to clipboard

Cookie configuration being used to send sessions

Constructors

Link copied to clipboard
fun CookieConfiguration()
Content copied to clipboard

Properties

Link copied to clipboard
var domain: String? = null
Content copied to clipboard

Cookie domain

Link copied to clipboard
var duration: TemporalAmount?
Content copied to clipboard

Cookie time to live duration or null for session cookies. Session cookies are client-driven. For example, a web browser usually removes session cookies at browser or window close unless the session is restored.

Link copied to clipboard
var encoding: CookieEncoding
Content copied to clipboard

Cookie encoding

Link copied to clipboard
val extensions: MutableMap<String, String?>
Content copied to clipboard

Any additional extra cookie parameters

Link copied to clipboard
var httpOnly: Boolean = true
Content copied to clipboard

This cookie is only for transferring over HTTP(s) and shouldn't be accessible via JavaScript

Link copied to clipboard
var maxAgeInSeconds: Long
Content copied to clipboard

Cookie time to live duration or 0 for session cookies. Session cookies are client-driven. For example, a web browser usually removes session cookies at browser or window close unless the session is restored.

Link copied to clipboard
var path: String?
Content copied to clipboard

Cookie path

Link copied to clipboard
var secure: Boolean = false
Content copied to clipboard

Send cookies only over secure connection

Extensions

Link copied to clipboard
var CookieConfiguration.duration: TemporalAmount?
Content copied to clipboard
Link copied to clipboard
@ExperimentalTime
var CookieConfiguration.maxAge: Duration?
Content copied to clipboard

Cookie time to live duration or null for session cookies. Session cookies are client-driven. For example, a web browser usually removes session cookies at browser or window close unless the session is restored.