ktor-http/io.ktor.http/ContentType

ContentType

class ContentType : HeaderValueWithParameters(source)

Represents a value for a Content-Type header.

Report a problem

Constructors

constructor(contentType: String, contentSubtype: String, parameters: List<HeaderValueParam> = emptyList())

Types

object Application

Provides a list of standard subtypes of an application content type.

object Audio

Provides a list of standard subtypes of an audio content type.

object Companion

object Font

Provides a list of standard subtypes of a font content type.

object Image

Provides a list of standard subtypes of an image content type.

object Message

Provides a list of standard subtypes of a message content type.

object MultiPart

Provides a list of standard subtypes of a multipart content type.

object Text

Provides a list of standard subtypes of a text content type.

object Video

Provides a list of standard subtypes of a video content type.

Properties

val contentSubtype: String

represents a subtype part of the media type.

val contentType: String

represents a type part of the media type.

val parameters: List<HeaderValueParam>

Functions

fun HeaderValueWithParameters.charset(): Charset?

Extracts a Charset value from the given Content-Type, Content-Disposition or similar header value.

open operator override fun equals(other: Any?): Boolean

fun ContentType.fileExtensions(): List<String>

Recommended file name extensions for this content type

open override fun hashCode(): Int

fun ContentType.isTextType(): Boolean

Returns true if the content type represents textual data. For binary data, returns false.

fun match(pattern: ContentType): Boolean

Checks if this type matches a pattern type taking into account placeholder symbols * and parameters. The this type must be a more specific type than the pattern type. In other words:

fun match(pattern: String): Boolean

Checks if this type matches a pattern type taking into account placeholder symbols * and parameters.

fun parameter(name: String): String?

The first value for the parameter with name comparing case-insensitively or null if no such parameters found

open override fun toString(): String

fun ContentType.withCharset(charset: Charset): ContentType

Creates a copy of this type with the added charset parameter with charset value.

withCharsetIfNeeded

fun ContentType.withCharsetIfNeeded(charset: Charset): ContentType

Creates a copy of this type with the added charset parameter with charset value if ContentType is not ignored

withoutParameters

fun withoutParameters(): ContentType

Creates a copy of this type without any parameters

fun withParameter(name: String, value: String): ContentType

Creates a copy of this type with the added parameter with the name and value.