request/co.anitrend.arch.request.contract/IRequestHelper

IRequestHelper

interface IRequestHelper

Request helper contract

Since

v1.3.0

Inheritors

AbstractRequestHelper

Types

interface Listener

Listener interface to get notified by request status changes.

Functions

abstract fun addListener(listener: IRequestHelper.Listener): Boolean

Adds a new listener that will be notified when any request changes Request.Status.

hasAnyWithStatus

abstract suspend fun hasAnyWithStatus(status: Request.Status): Boolean

Check if request handler has any finished request with status

abstract suspend fun recordResult(wrapper: RequestWrapper, throwable: RequestError?)

Records the result of the result of a request

abstract fun removeListener(listener: IRequestHelper.Listener): Boolean

Removes the given listener from the listeners list.

retryWithStatus

abstract suspend fun retryWithStatus(status: Request.Status = Request.Status.FAILED, action: suspend () -> Unit): Boolean

Retries all request types for a given status.

runIfNotRunning

abstract suspend fun runIfNotRunning(request: Request, handleCallback: suspend (RequestCallback) -> Unit): Boolean

Runs the given RequestCallback if no other requests in the given request type is already running. If run, the request will be run in the current thread.