ktor-client-content-negotiation/io.ktor.client.plugins.contentnegotiation/ContentNegotiationConfig

ContentNegotiationConfig

class ContentNegotiationConfig : Configuration(source)

A ContentNegotiation configuration that is used during installation.

Report a problem

Constructors

constructor()

Properties

acceptHeaderMergeStrategy

var acceptHeaderMergeStrategy: ContentTypeMergeStrategy

Controls how registered content types are merged into the Accept header. Defaults to ContentTypeMergeStrategy.Default, which preserves backward-compatible behavior.

defaultAcceptHeaderQValue

var defaultAcceptHeaderQValue: Double?

By default, Accept headers for registered content types will have no q value (implicit 1.0). Set this to change that behavior. This is useful to override the preferred Accept content types on a per-request basis.

Functions

clearIgnoredTypes

fun clearIgnoredTypes()

Clear all configured ignored types including defaults.

ignoreType

inline fun <T> ignoreType()

Adds a type to the list of types that should be ignored by ContentNegotiation.

fun ignoreType(type: KClass<*>)

Adds a type to the list of types that should be ignored by ContentNegotiation.

open override fun <T : ContentConverter> register(contentType: ContentType, converter: T, configuration: T.() -> Unit)

Registers a contentType to a specified converter with an optional configuration script for a converter.

fun <T : ContentConverter> register(contentTypeToSend: ContentType, converter: T, contentTypeMatcher: ContentTypeMatcher, configuration: T.() -> Unit)

Registers a contentTypeToSend and contentTypeMatcher to a specified converter with an optional configuration script for a converter.

removeIgnoredType

inline fun <T> removeIgnoredType()

Remove T from the list of types that should be ignored by ContentNegotiation.

fun removeIgnoredType(type: KClass<*>)

Remove type from the list of types that should be ignored by ContentNegotiation.