ktor-server-sessions/io.ktor.server.sessions/header

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.

Report a problem

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.

Report a problem

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.

In the example below, session data will be passed to the client using the cart_session custom header.

install(Sessions) {
    header<CartSession>("cart_session")
}
Content copied to clipboard

On the client side, you need to append this header to each request to get session data.

Report a problem

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.

Report a problem