APIManager/com.tecknobit.apimanager.apis/APIRequest/Params

Params

open class Params

The Params class is useful to assemble params values for the request

Constructors

Params

constructor()

Constructor to init Params No-any params required

constructor(mergeParams: APIRequest.Params)

Constructor to init Params

Properties

apiRequest

private val apiRequest: APIRequest

apiRequest is the instance for APIRequest object

params

private val params: HashMap<String, Any>

params is the instance that contains params value

Functions

addParam

open fun <T> addParam(keyParam: String, valueParam: T)

Method to add a new param value

clear

open fun clear()

Method to clear all params No-any params required

createJSONPayload

open fun createJSONPayload(): JSONObject

Method to assemble a body params of an "HTTP" request No-any params required

open fun createJSONPayload(extraPayload: APIRequest.Params): JSONObject

Method to assemble a body params of an "HTTP" request

createPayload

open fun createPayload(): String

Method to assemble a body params of an "HTTP" request No-any params required

open fun createPayload(extraPayload: APIRequest.Params): String

Method to assemble a body params of an "HTTP" request

createQueryString

open fun createQueryString(): String

Method to assemble a query params string No-any params required

open fun createQueryString(mandatoryParams: APIRequest.Params): String

open fun createQueryString(mandatoryParams: String): String

Method to assemble a query params string

getAllParams

open fun <T> getAllParams(): Collection<T>

Method to get all params value No-any params required

getParam

open fun <T> getParam(paramKey: String): T

Method to get a param value

getParamsKeys

open fun getParamsKeys(): Set<String>

Method to get all params keys No-any params required

mergeParams

open fun mergeParams(mergeParams: APIRequest.Params)

Method to merge another params value in the same object

removeParam

open fun removeParam(keyParam: String)

Method to remove a param

toString

open fun toString(): String

Returns a string representation of the object No-any params required