Goonstation 13 - Modules - TypesProc Details

/datum/apiHandler

Procs

queryAPIConstructs a query to send to the goonhub web API
retryApiQueryRetries an API query in the event of failure
trackRecentErrorIncrements or resets the recent error counter

Proc Details

queryAPI

Constructs a query to send to the goonhub web API

@route (string) requested route e.g. bans/check @query (list) query arguments to be passed along to route @forceResponse (boolean) will force the API server to return the requested data from the route rather than hitting hubCallback later on @attempt (int) number of times we've attempted this query @return (list|boolean) list containing parsed data response from api, 1 if forceResponse is false

retryApiQuery

Retries an API query in the event of failure

@givenArgs (list) arglist of the failed query attempt @attempt (int) number of times we've attempted this query @return (*) the result of another query attempt

trackRecentError

Increments or resets the recent error counter

@reset (bool) reset the counter (eg successful request)