kjwt-core/co.touchlab.kjwt.builder/JwtBuilder/header

header

fun header(name: String, value: JsonElement): JwtBuilder(source)

Sets a raw extra header parameter using a pre-built JsonElement.

Return

this builder for chaining

Parameters

name

the header parameter name

value

the header value as a JsonElement

fun <T> header(name: String, serializer: SerializationStrategy<T>, value: T?): JwtBuilder(source)

Sets a typed extra header parameter using an explicit SerializationStrategy.

Return

this builder for chaining

Parameters

name

the header parameter name

serializer

the serialization strategy for T

value

the header value, or null to remove the parameter

inline fun <T> header(name: String, value: T): JwtBuilder(source)

Sets a typed extra header parameter, inferring the serializer from the reified type T.

Return

this builder for chaining

Parameters

name

the header parameter name

value

the header value

fun header(block: JwtHeader.Builder.() -> Unit): JwtBuilder(source)

Configures JOSE header fields using a DSL block applied to JwtHeader.Builder.

Return

this builder for chaining

Parameters

block

the configuration block

fun <T> header(serializer: SerializationStrategy<T>, value: T): JwtBuilder(source)

Merges all fields from value into the JOSE header, encoded using serializer.

The object is serialized to a JSON object and each key-value pair is added to the header, overwriting any existing parameter with the same name.

Return

this builder for chaining

Parameters

serializer

the serialization strategy for T

value

the object whose fields should be merged into the header

inline fun <T> header(value: T): JwtBuilder(source)

Merges all fields from value into the JOSE header, inferring the serializer from the reified type T.

The object is serialized to a JSON object and each key-value pair is added to the header, overwriting any existing parameter with the same name.

Return

this builder for chaining

Parameters

value

the object whose fields should be merged into the header