kobwebx-serialization-kotlinx/com.varabyte.kobweb.browser/tryPost

tryPost

inline suspend fun <B, T> ApiFetcher.tryPost(apiPath: String, body: B, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, bodySerializer: SerializationStrategy<B> = serializer(), noinline transform: suspend Response.() -> T): T?(source)

A serialize-friendly version of tryPost that accepts a serializable body and logic to convert the response to some desired target object of type T.

A transform callback is provided allowing you to convert the response into a different type. You are generally encouraged to call tryPost(...) { convert() } over tryPost(...)?.convert() as the former will ensure that exception handling is covered in that case.

Additionally, if ApiFetcher.logOnError is set to true, any failure will be logged to the console (including the logic in the transform block).

If you do not care about converting the result to some arbitrary type, use the tryPost version that returns Response? instead. For serialization-aware methods, it is expected that users will rarely, if ever, need this version. Instead, via the Response version, use tryPost<RequestClass>().bodyAs<ReplyClass>()

inline suspend fun <B> ApiFetcher.tryPost(apiPath: String, body: B, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, bodySerializer: SerializationStrategy<B> = serializer()): Response?(source)

Like post but returns null instead of throwing if the request fails.

Additionally, if ApiFetcher.logOnError is set to true, any failure will be logged to the console. By default, this will be true for debug builds and false for release builds.

If you plan to do additional operations on the response and would also like to have logging / exception protection for them, consider using the other tryPost call which lets you pass in a transform callback. You are generally encouraged to call tryPost(...) { convert() } over tryPost(...)?.convert().

Note: you should NOT prepend your path with "api/", as that will be added automatically.

inline suspend fun <B, R> ApiFetcher.~~tryPost~~(apiPath: String, body: B, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, bodySerializer: SerializationStrategy<B> = serializer(), responseDeserializer: DeserializationStrategy<R> = serializer()): R?(source)

Deprecated

With these serialization-aware network methods, we are moving response deserialization handling to a separate `bodyAs` call. This lets us accomplish the same amount of functionality with fewer methods.

Replace with

import com.varabyte.kobweb.browser.tryPost
import com.varabyte.kobweb.browser.http.FetchDefaults
import com.varabyte.kobweb.browser.http.bodyAs
import kotlinx.serialization.serializer

tryPost(apiPath, body, headers, redirect, abortController, bodySerializer) { bodyAs(responseDeserializer) }

Like post, but returns null if the request fails or the response can't be deserialized.

Additionally, if ApiFetcher.logOnError is set to true, any failure will be logged to the console. By default, this will be true for debug builds and false for release builds.

Note: you should NOT prepend your path with "api/", as that will be added automatically.

inline suspend fun <R> ApiFetcher.~~tryPost~~(apiPath: String, headers: Map<String, Any>? = FetchDefaults.Headers, redirect: RequestRedirect? = FetchDefaults.Redirect, abortController: AbortController? = null, responseDeserializer: DeserializationStrategy<R> = serializer()): R?(source)

Deprecated

Replace with

import com.varabyte.kobweb.browser.tryPost
import com.varabyte.kobweb.browser.http.FetchDefaults
import com.varabyte.kobweb.browser.http.bodyAs
import kotlinx.serialization.serializer

tryPost(apiPath, body = null, headers, redirect, abortController) { bodyAs(responseDeserializer) }

A serialize-friendly version of tryPost that has no body but provides a serialized response.

Note: you should NOT prepend your path with "api/", as that will be added automatically.