commonMain.com.algolia.search.transport.RequestOptions.kt Maven / Gradle / Ivy

Go to download
package com.algolia.search.transport

import com.algolia.search.model.multicluster.UserID
import com.algolia.search.serialize.internal.Key
import kotlinx.serialization.json.JsonObject

/**
 * Every endpoint can configure a request locally by passing additional
 * [headers], [urlParameters], [body], [writeTimeout], [readTimeout].
 */
public class RequestOptions {

    public val headers: MutableMap = mutableMapOf()
    public val urlParameters: MutableMap = mutableMapOf()

    public var writeTimeout: Long? = null
    public var readTimeout: Long? = null
    public var body: JsonObject? = null

    /**
     * Add a "X-Forwarded-For" header with an [ipAddress] to [headers].
     */
    public fun headerForwardedFor(ipAddress: String) {
        headers[Key.ForwardedFor] = ipAddress
    }

    /**
     * Add a "X-Algolia-User-ID" header with an [userId] to [headers].
     */
    public fun headerAlgoliaUserId(userId: UserID) {
        headers[Key.AlgoliaUserID] = userId.raw
    }

    /**
     * Add a url parameter with [key] and [value] to [urlParameters].
     */
    public fun parameter(key: String, value: Any?) {
        value?.let { urlParameters[key] = it }
    }

    /**
     * Add a header with [key] and [value] to [headers].
     */
    public fun header(key: String, value: Any?) {
        value?.let { headers[key] = it }
    }
}