# Package-level declarations

## Types

CorrectCloseException
Link copied to clipboard
object CorrectCloseException : Exception

An exception used to indicate a correct/normal closure of a connection or stream. This is typically used in WebSocket or network communication scenarios where a clean shutdown needs to be distinguished from error conditions.

FromToDateTime
Link copied to clipboard
typealias FromToDateTime = Pair <DateTime?, DateTime?>

Type alias representing a date-time range with optional start and end times. First element is the "from" date-time, second is the "to" date-time.

LambdaInputProvider
Link copied to clipboard
typealias LambdaInputProvider = () -> ERROR CLASS: Symbol not found for Input

A function type that provides an Input instance. This is useful for lazy or deferred input creation in Ktor operations.

QueryParam
Link copied to clipboard
typealias QueryParam = Pair < String , String ?>
QueryParams
Link copied to clipboard
typealias QueryParams = Map < String , String ?>
StandardKtorSerialFormat
Link copied to clipboard
typealias StandardKtorSerialFormat = BinaryFormat

Type alias for the standard serialization format used in Ktor utilities, which is BinaryFormat.

StandardKtorSerialInputData
Link copied to clipboard
typealias StandardKtorSerialInputData = ByteArray

Type alias for the standard serialization input data type, which is ByteArray.

TemporalFileId
Link copied to clipboard
@Serializable
@ JvmInline
value class TemporalFileId (val string: String )

A value class representing a unique identifier for a temporal file. Temporal files are typically used for temporary storage during file upload/processing operations.

## Properties

asCorrectWebSocketUrl
Link copied to clipboard
val String . asCorrectWebSocketUrl : String

Converts this string to a correct WebSocket URL by ensuring it starts with "ws://" scheme. If the URL already starts with "ws", it is returned unchanged. If the URL contains a scheme (e.g., "http://"), it is replaced with "ws://". If the URL has no scheme, "ws://" is prepended.

asFromToUrlPart
Link copied to clipboard
val FromToDateTime . asFromToUrlPart : QueryParams

Converts this FromToDateTime range to URL query parameters. Creates "from" and "to" query parameters with Unix millisecond timestamps.

asUrlQuery
Link copied to clipboard
val List < QueryParam >. asUrlQuery : String
val QueryParams . asUrlQuery : String

Create query part which includes key=value pairs separated with &

cbor
Link copied to clipboard
val cbor : ERROR CLASS: Unresolved name: Cbor

A CBOR instance for serialization operations.

DefaultTemporalFilesSubPath
Link copied to clipboard
const val DefaultTemporalFilesSubPath : String

The default subdirectory path for storing temporal files during upload operations.

extractFromToDateTime
Link copied to clipboard
val QueryParams . extractFromToDateTime : FromToDateTime

Extracts a FromToDateTime range from URL query parameters. Looks for "from" and "to" parameters containing Unix millisecond timestamps.

parseUrlQuery
Link copied to clipboard
val String . parseUrlQuery : QueryParams

Parses this URL query string into a QueryParams map. Splits on '&' to separate parameters and '=' to separate keys from values. Parameters without values will have null as their value.

standardKtorSerialFormat
Link copied to clipboard
val standardKtorSerialFormat : StandardKtorSerialFormat

The standard Ktor serialization format instance, configured as CBOR.

## Functions

buildStandardUrl
Link copied to clipboard
fun buildStandardUrl (basePart: String , subpart: String , parameters: List < QueryParam >): String

Builds a standard URL by combining a base part, subpart, and query parameters as a list. The base and subpart are joined with a '/', and query parameters are appended.

fun buildStandardUrl (basePart: String , subpart: String , parameters: QueryParams = emptyMap()): String

Builds a standard URL by combining a base part, subpart, and optional query parameters. The base and subpart are joined with a '/', and query parameters are appended.

fun buildStandardUrl (basePart: String , subpart: String , vararg parameters: QueryParam ): String

Builds a standard URL by combining a base part, subpart, and vararg query parameters. The base and subpart are joined with a '/', and query parameters are appended.

decodeDefault
Link copied to clipboard
inline fun < T > StandardKtorSerialFormat . decodeDefault (deserializationStrategy: DeserializationStrategy< T >, input: StandardKtorSerialInputData ): T

Decodes data from StandardKtorSerialInputData using the standard format.

decodeHex
Link copied to clipboard
inline fun < T > StandardKtorSerialFormat . decodeHex (deserializationStrategy: DeserializationStrategy< T >, input: String ): T

Decodes data from a hex string using the standard binary format.

downloadToTempFile
Link copied to clipboard
fun ERROR CLASS: Symbol not found for Source. downloadToTempFile (fileName: String = UUID.randomUUID().toString(), fileExtension: String ? = ".temp", folder: File ? = null): File ?
encodeDefault
Link copied to clipboard
inline fun < T > StandardKtorSerialFormat . encodeDefault (serializationStrategy: SerializationStrategy< T >, data: T ): StandardKtorSerialInputData

Encodes data to StandardKtorSerialInputData using the standard format.

encodeHex
Link copied to clipboard
inline fun < T > StandardKtorSerialFormat . encodeHex (serializationStrategy: SerializationStrategy< T >, data: T ): String

Encodes data to a hex string using the standard binary format.

includeQueryParams
Link copied to clipboard
fun String . includeQueryParams (queryParams: List < QueryParam >): String
fun String . includeQueryParams (queryParams: QueryParams ): String

Create query part which includes key=value pairs separated with & and attach to receiver

input
Link copied to clipboard
expect fun MPPFile . input (): ERROR CLASS: Symbol not found for Input

Creates a Ktor Input from this multiplatform file. Platform-specific implementations handle file reading for each supported platform.

actual fun MPPFile . input (): ERROR CLASS: Symbol not found for Input

Creates a Ktor Input from this multiplatform file. Platform-specific implementations handle file reading for each supported platform.

actual fun MPPFile . input (): ERROR CLASS: Symbol not found for Input

Creates a Ktor Input from this multiplatform file. Platform-specific implementations handle file reading for each supported platform.