ktor-client-json/io.ktor.client.plugins.json/JsonPlugin/Config

Config

JsonPlugin configuration that is used during installation

Constructors

Functions

fun accept(vararg contentTypes: ContentType)

Adds accepted content types. Be aware that ContentType.Application.Json accepted by default is removed from the list if you use this function to provide accepted content types. It also affects Accept request header value.

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.

receive

fun receive(matcher: ContentTypeMatcher)

Adds accepted content types. Existing content types will not be removed.

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.

Properties

acceptContentTypes

var acceptContentTypes: List<ContentType>

List of content types that are handled by this plugin. It also affects Accept request header value. Please note that wildcard content types are supported but no quality specification provided.

receiveContentTypeMatchers

var receiveContentTypeMatchers: List<ContentTypeMatcher>

List of content type matchers that are handled by this plugin. Please note that wildcard content types are supported but no quality specification provided.

serializer

var serializer: JsonSerializer? = null

Serializer that will be used for serializing requests and deserializing response bodies.