kotlin-actions-http-client/actions.http.client/HttpClient

HttpClient

Constructors

constructor( userAgent: String = definedExternally, handlers: <Error class: unknown class><RequestHandler> = definedExternally, requestOptions: RequestOptions = definedExternally)

Properties

handlers

var handlers: <Error class: unknown class><RequestHandler>

requestOptions

var requestOptions: RequestOptions?

userAgent

var userAgent: String?

Functions

del

fun del(requestUrl: String, additionalHeaders: <Error class: unknown class> = definedExternally): <Error class: unknown class><HttpClientResponse>

dispose

fun dispose()

Needs to be called if keepAlive is set to true in request options.

get

fun get(requestUrl: String, additionalHeaders: <Error class: unknown class> = definedExternally): <Error class: unknown class><HttpClientResponse>

getAgent

fun getAgent(serverUrl: String): <Error class: unknown class>

Gets an http agent. This function is useful when you need an http agent that handles routing through a proxy server - depending upon the url and proxy environment variables.

getAgentDispatcher

fun getAgentDispatcher(serverUrl: String): Any?

getJson

fun <T> getJson( requestUrl: String, additionalHeaders: <Error class: unknown class> = definedExternally): <Error class: unknown class><TypedResponse<T>>

Gets a typed object from an endpoint Be aware that not found returns a null. Other errors (4xx, 5xx) reject the promise

head

fun head( requestUrl: String, additionalHeaders: <Error class: unknown class> = definedExternally): <Error class: unknown class><HttpClientResponse>

options

fun options( requestUrl: String, additionalHeaders: <Error class: unknown class> = definedExternally): <Error class: unknown class><HttpClientResponse>

patch

fun patch( requestUrl: String, data: String, additionalHeaders: <Error class: unknown class> = definedExternally): <Error class: unknown class><HttpClientResponse>

patchJson

fun <T> patchJson( requestUrl: String, obj: Any?, additionalHeaders: <Error class: unknown class> = definedExternally): <Error class: unknown class><TypedResponse<T>>

post

fun post( requestUrl: String, data: String, additionalHeaders: <Error class: unknown class> = definedExternally): <Error class: unknown class><HttpClientResponse>

postJson

fun <T> postJson( requestUrl: String, obj: Any?, additionalHeaders: <Error class: unknown class> = definedExternally): <Error class: unknown class><TypedResponse<T>>

put

fun put( requestUrl: String, data: String, additionalHeaders: <Error class: unknown class> = definedExternally): <Error class: unknown class><HttpClientResponse>

putJson

fun <T> putJson( requestUrl: String, obj: Any?, additionalHeaders: <Error class: unknown class> = definedExternally): <Error class: unknown class><TypedResponse<T>>

request

fun request( verb: String, requestUrl: String, data: <Error class: unknown class>?, headers: <Error class: unknown class> = definedExternally): <Error class: unknown class><HttpClientResponse>

fun request( verb: String, requestUrl: String, data: String?, headers: <Error class: unknown class> = definedExternally): <Error class: unknown class><HttpClientResponse>

Makes a raw http request. All other methods such as get, post, patch, and request ultimately call this. Prefer get, del, post and patch

requestRaw

fun requestRaw(info: RequestInfo, data: <Error class: unknown class>?): <Error class: unknown class><HttpClientResponse>

fun requestRaw(info: RequestInfo, data: String?): <Error class: unknown class><HttpClientResponse>

Raw request.

requestRawWithCallback

fun requestRawWithCallback( info: RequestInfo, data: <Error class: unknown class>?, onResult: (<Error class: unknown class>?, res: HttpClientResponse?) -> Unit)

fun requestRawWithCallback(info: RequestInfo, data: String?, onResult: (<Error class: unknown class>?, res: HttpClientResponse?) -> Unit)

Raw request with callback.

sendStream

fun sendStream( verb: String, requestUrl: String, stream: <Error class: unknown class>, additionalHeaders: <Error class: unknown class> = definedExternally): <Error class: unknown class><HttpClientResponse>