ktor-server-sessions/io.ktor.server.sessions/CookieIdSessionBuilder

CookieIdSessionBuilder

class CookieIdSessionBuilder<S : Any> : CookieSessionBuilder<S> (source)

A configuration that allows you to configure additional cookie settings for Sessions, for example:

add cookie attributes;
sign and encrypt session data.

Report a problem

Properties

val cookie: CookieConfiguration

Gets a configuration used to specify additional cookie attributes for Sessions.

sendOnlyIfModified

var sendOnlyIfModified: Boolean

When set to true, session data is not re-sent if unchanged from the incoming value. This avoids unnecessary Set-Cookie headers but prevents cookie expiration refresh. Session classes should properly implement equals() for this to work correctly. Default: false.

serializer

var serializer: SessionSerializer<S>

Specifies a serializer used to serialize session data.

sessionIdProvider

var ~~sessionIdProvider~~: () -> String

A function used to provide a current session ID.

transformers

val transformers: List<SessionTransportTransformer>

Gets transformers used to sign and encrypt session data.

type

val type: KClass<S>

typeInfo