equinox-backend/com.tecknobit.equinoxbackend/Requester/Companion

Companion

object Companion

Properties

DEFAULT_CONNECTION_ERROR_MESSAGE

const val DEFAULT_CONNECTION_ERROR_MESSAGE: String

DEFAULT_CONNECTION_ERROR_MESSAGE the message to send when an error during the communication with the backend occurred

RESPONSE_DATA_KEY

const val RESPONSE_DATA_KEY: String

RESPONSE_DATA_KEY the key for the "response" field

RESPONSE_STATUS_KEY

const val RESPONSE_STATUS_KEY: String

RESPONSE_STATUS_KEY the key for the "status" field

USER_IDENTIFIER_KEY

const val USER_IDENTIFIER_KEY: String

USER_IDENTIFIER_KEY the key for the user "id" field

const val USER_TOKEN_KEY: String

USER_TOKEN_KEY the key for the user "token" field

Functions

isSuccessfulResponse

private fun isSuccessfulResponse(response: JSONObject?): SocketManager.StandardResponseCode

Method to get whether the request has been successful or not

fun <T> JsonHelper.responseData(): T

Extension Method to get directly the response data from the request response

sendPaginatedRequest

fun <R : Requester, T> R.sendPaginatedRequest(request: R.() -> JSONObject, supplier: (JSONObject) -> T, onSuccess: (PaginatedResponse<T>) -> Unit, onFailure: (JsonHelper) -> Unit, onConnectionError: (JsonHelper) -> Unit? = null)

Method to execute and manage the paginated response of a request

fun <R : Requester> R.sendRequest(request: R.() -> JSONObject, onResponse: (JsonHelper) -> Unit, onConnectionError: (JsonHelper) -> Unit? = null)

fun <R : Requester> R.sendRequest(request: R.() -> JSONObject, onSuccess: (JsonHelper) -> Unit, onFailure: (JsonHelper) -> Unit, onConnectionError: (JsonHelper) -> Unit? = null)

Method to execute and manage the response of a request