koogle-api-common/io.github.edricchan03.koogle_api.common.http.params/KoogleParametersBuilder

KoogleParametersBuilder

abstract class KoogleParametersBuilder(parametersBuilder: ParametersBuilder) : ParametersBuilder(source)

Top-level class that all query parameter builders should extend from.

Parameters

parametersBuilder

The Ktor header builder to extend from.

Inheritors

SystemParametersBuilder

Constructors

KoogleParametersBuilder

constructor(parametersBuilder: ParametersBuilder)

Inherited properties

caseInsensitiveName

open override val caseInsensitiveName: Boolean

Functions

appendToBuilder

fun appendToBuilder(defaultRequestBuilder: DefaultRequest.DefaultRequestBuilder)

Applies the parameters to the specified defaultRequestBuilder.

fun appendToBuilder(httpRequestBuilder: HttpRequestBuilder)

Applies the parameters to the specified httpRequestBuilder.

fun appendToBuilder(urlBuilder: URLBuilder)

Applies the parameters to the specified urlBuilder.

Inherited functions

append

open override fun append(name: String, value: String)

appendAll

open override fun appendAll(stringValues: StringValues)

open override fun appendAll(name: String, values: Iterable<String>)

appendMissing

open override fun appendMissing(stringValues: StringValues)

open override fun appendMissing(name: String, values: Iterable<String>)

booleanValue

fun StringValuesBuilder.booleanValue(name: String? = null, toBoolean: StringToBoolean = defaultStringToBoolean, toString: BooleanToString = defaultBooleanToString): ValueSingleDelegateProvider<Boolean?>

Creates an optional parameter of type Boolean with the given name in this StringValuesBuilder instance.

booleanValues

fun StringValuesBuilder.booleanValues(name: String? = null, toBoolean: StringToBoolean = defaultStringToBoolean, toString: BooleanToString = defaultBooleanToString): NamedValuePropertyProvider<List<Boolean>?>

Creates an optional parameter of type List<Boolean> with the given name in this StringValuesBuilder instance.

build

open override fun build(): Parameters

byteValue

fun StringValuesBuilder.byteValue(name: String? = null, toByte: StringToByte = defaultStringToByte, toString: ByteToString = defaultByteToString): ValueSingleDelegateProvider<Byte?>

Creates an optional parameter of type Byte with the given name in this StringValuesBuilder instance.

byteValues

fun StringValuesBuilder.byteValues(name: String? = null, toByte: StringToByte = defaultStringToByte, toString: ByteToString = defaultByteToString): NamedValuePropertyProvider<List<Byte>?>

Creates an optional parameter of type List<Byte> with the given name in this StringValuesBuilder instance.

clear

open override fun clear()

contains

open operator override fun contains(name: String): Boolean

open override fun contains(name: String, value: String): Boolean

contentTypeValue

fun StringValuesBuilder.contentTypeValue(name: String? = null): ValueSingleDelegateProvider<ContentType?>

Creates an optional Content-Type header of type ContentType with the given name in this KoogleHeadersBuilder instance.

contentTypeValues

fun StringValuesBuilder.contentTypeValues(name: String? = null): NamedValuePropertyProvider<List<ContentType>?>

Creates an optional Content-Type header of type List<ContentType> with the given name in this KoogleHeadersBuilder instance.

doubleValue

fun StringValuesBuilder.doubleValue(name: String? = null, toDouble: StringToDouble = defaultStringToDouble, toString: DoubleToString = defaultDoubleToString): ValueSingleDelegateProvider<Double?>

Creates an optional parameter of type Double with the given name in this StringValuesBuilder instance.

doubleValues

fun StringValuesBuilder.doubleValues(name: String? = null, toDouble: StringToDouble = defaultStringToDouble, toString: DoubleToString = defaultDoubleToString): NamedValuePropertyProvider<List<Double>?>

Creates an optional parameter of type List<Double> with the given name in this StringValuesBuilder instance.

entries

open override fun entries(): Set<Map.Entry<String, List<String>>>

enumValue

inline fun <E : Enum<E>> StringValuesBuilder.enumValue(name: String? = null, noinline toEnum: (String) -> E? = { enumValueOf<E>(it) }, noinline toString: (E) -> String = { it.toString() }): ValueSingleDelegateProvider<E?>

Creates an optional parameter of type E with the given name in this StringValuesBuilder instance.

enumValues

inline fun <E : Enum<E>> StringValuesBuilder.enumValues(name: String? = null, noinline toEnum: (String) -> E? = { enumValueOf<E>(it) }, noinline toString: (E) -> String = { it.toString() }): NamedValuePropertyProvider<List<E>?>

Creates an optional parameter of type List<E> with the given name in this StringValuesBuilder instance.

floatValue

fun StringValuesBuilder.floatValue(name: String? = null, toFloat: StringToFloat = defaultStringToFloat, toString: FloatToString = defaultFloatToString): ValueSingleDelegateProvider<Float?>

Creates an optional parameter of type Float with the given name in this StringValuesBuilder instance.

floatValues

fun StringValuesBuilder.floatValues(name: String? = null, toFloat: StringToFloat = defaultStringToFloat, toString: FloatToString = defaultFloatToString): NamedValuePropertyProvider<List<Float>?>

Creates an optional parameter of type List<Float> with the given name in this StringValuesBuilder instance.

get

open operator override fun get(name: String): String?

getAll

open override fun getAll(name: String): List<String>?

intValue

fun StringValuesBuilder.intValue(name: String? = null, toInt: StringToInt = defaultStringToInt, toString: IntToString = defaultIntToString): ValueSingleDelegateProvider<Int?>

Creates an optional parameter of type Int with the given name in this StringValuesBuilder instance.

intValues

fun StringValuesBuilder.intValues(name: String? = null, toInt: StringToInt = defaultStringToInt, toString: IntToString = defaultIntToString): NamedValuePropertyProvider<List<Int>?>

Creates an optional parameter of type List<Int> with the given name in this StringValuesBuilder instance.

isEmpty

open override fun isEmpty(): Boolean

longValue

fun StringValuesBuilder.longValue(name: String? = null, toLong: StringToLong = defaultStringToLong, toString: LongToString = defaultLongToString): ValueSingleDelegateProvider<Long?>

Creates an optional parameter of type Long with the given name in this StringValuesBuilder instance.

longValues

fun StringValuesBuilder.longValues(name: String? = null, toLong: StringToLong = defaultStringToLong, toString: LongToString = defaultLongToString): NamedValuePropertyProvider<List<Long>?>

Creates an optional parameter of type List<Long> with the given name in this StringValuesBuilder instance.

minusAssign

operator fun StringValuesBuilder.minusAssign(name: String)

Removes the specified string-value (by name) using -= syntax.

operator fun StringValuesBuilder.minusAssign(names: Iterable<String>)

Removes the specified string-value (by names) using -= syntax.

operator fun StringValuesBuilder.minusAssign(properties: Iterable<KProperty<*>>)

Removes the specified string-value (by properties) using -= syntax.

operator fun StringValuesBuilder.minusAssign(property: KProperty<*>)

Removes the specified string-value (by property) using -= syntax.

names

open override fun names(): Set<String>

plusAssign

operator fun StringValuesBuilder.plusAssign(value: Parameters)

operator fun StringValuesBuilder.plusAssign(value: Pair<String, String>)

operator fun StringValuesBuilder.plusAssign(value: Pair<String, Iterable<String>>)

Adds the specified string-value using += syntax.

remove

open override fun remove(name: String)

open override fun remove(name: String, value: String): Boolean

removeKeysWithNoEntries

open override fun removeKeysWithNoEntries()

set

open operator override fun set(name: String, value: String)

set

operator fun StringValuesBuilder.set(name: String, values: Iterable<String>)

Sets the specified string-value.

shortValue

fun StringValuesBuilder.shortValue(name: String? = null, toShort: StringToShort = defaultStringToShort, toString: ShortToString = defaultShortToString): ValueSingleDelegateProvider<Short?>

Creates an optional parameter of type Short with the given name in this StringValuesBuilder instance.

shortValues

fun StringValuesBuilder.shortValues(name: String? = null, toShort: StringToShort = defaultStringToShort, toString: ShortToString = defaultShortToString): NamedValuePropertyProvider<List<Short>?>

Creates an optional parameter of type List<Short> with the given name in this StringValuesBuilder instance.

stringValue

fun StringValuesBuilder.stringValue(name: String? = null, toParsedString: StringParamToString = defaultStringParamToString, toParamString: StringToStringParam = defaultStringToStringParam): ValueSingleDelegateProvider<String?>

Creates an optional parameter of type String with the given name in this StringValuesBuilder instance.

stringValues

fun StringValuesBuilder.stringValues(name: String? = null, toParsedString: StringParamToString = defaultStringParamToString, toParamString: StringToStringParam = defaultStringToStringParam): NamedValuePropertyProvider<List<String>?>

Creates an optional parameter of type List<String> with the given name in this StringValuesBuilder instance.

value

fun StringValuesBuilder.value(name: String? = null, defaultValue: String? = null): ReadWriteProperty<KoogleParametersBuilder, String?>

Sets a string-value via the delegation pattern.

valueList

fun StringValuesBuilder.valueList(name: String? = null, defaultValue: List<String> = emptyList(), clearListOnSet: Boolean = true): ReadWriteProperty<StringValuesBuilder, List<String>?>

Sets a string-value via the delegation pattern.