ktor-server-sessions/io.ktor.server.sessions/SessionsConfig

SessionsConfig

class SessionsConfig

A configuration for the Sessions plugin.

Constructors

SessionsConfig

constructor()

Properties

providers

val providers: List<SessionProvider<*>>

Gets a list of session providers to be registered.

Functions

inline fun <S : Any> SessionsConfig.cookie(name: String)

fun <S : Any> SessionsConfig.cookie(name: String, typeInfo: TypeInfo)

Configures Sessions to pass the serialized session's data in cookies using the name Set-Cookie attribute.

inline fun <S : Any> SessionsConfig.cookie(name: String, storage: SessionStorage)

fun <S : Any> SessionsConfig.cookie(name: String, typeInfo: TypeInfo, storage: SessionStorage)

Configures Sessions to pass a session identifier in cookies using the name Set-Cookie attribute and store the serialized session's data in the server storage.

inline fun <S : Any> SessionsConfig.cookie(name: String, noinline block: CookieSessionBuilder<S>.() -> Unit)

fun <S : Any> SessionsConfig.cookie(name: String, typeInfo: TypeInfo, block: CookieSessionBuilder<S>.() -> Unit)

Configures Sessions to pass the serialized session's data in cookies using the name Set-Cookie attribute. The block parameter allows you to configure additional cookie settings, for example:

inline fun <S : Any> SessionsConfig.cookie(name: String, storage: SessionStorage, noinline block: CookieIdSessionBuilder<S>.() -> Unit)

fun <S : Any> SessionsConfig.cookie(name: String, typeInfo: TypeInfo, storage: SessionStorage, block: CookieIdSessionBuilder<S>.() -> Unit)

Configures Sessions to pass a session identifier in cookies using the name Set-Cookie attribute and store the serialized session's data in the server storage. The block parameter allows you to configure additional cookie settings, for example:

header

inline fun <S : Any> SessionsConfig.header(name: String)

fun <S : Any> SessionsConfig.header(name: String, typeInfo: TypeInfo)

Configures Sessions to pass the serialized session's data in a name HTTP header.

inline fun <S : Any> SessionsConfig.header(name: String, storage: SessionStorage)

fun <S : Any> SessionsConfig.header(name: String, typeInfo: TypeInfo, storage: SessionStorage)

Configures Sessions to pass a session identifier in a name HTTP header and store the serialized session's data in the server storage.

inline fun <S : Any> SessionsConfig.header(name: String, noinline block: HeaderSessionBuilder<S>.() -> Unit)

fun <S : Any> SessionsConfig.header(name: String, typeInfo: TypeInfo, block: HeaderSessionBuilder<S>.() -> Unit)

Configures Sessions to pass the serialized session's data in a name HTTP header. The block parameter allows you to configure additional settings, for example, sign and encrypt session data.

inline fun <S : Any> SessionsConfig.header(name: String, storage: SessionStorage, noinline block: HeaderIdSessionBuilder<S>.() -> Unit)

fun <S : Any> SessionsConfig.header(name: String, typeInfo: TypeInfo, storage: SessionStorage, block: HeaderIdSessionBuilder<S>.() -> Unit)

Configures Sessions to pass a session identifier in a name HTTP header and store the serialized session's data in the server storage. The block parameter allows you to configure additional settings, for example, sign and encrypt session data.

fun register(provider: SessionProvider<*>)

Registers a session provider.