A+ Courses/fi.aalto.cs.apluscourses.services/CoursesClient

CoursesClient

class CoursesClient(val cs: <Error class: unknown class>)

A utility class with methods for getting resources from a remote. For most use cases, the CoursesClient.fetch methods are sufficient. The CoursesClient.fetchAndMap and CoursesClient.fetchAndConsume methods can be used when direct access to the input stream of the response is needed.

Constructors

CoursesClient

constructor(cs: <Error class: unknown class>)

Types

HttpAuthentication

fun interface HttpAuthentication

A functional interface for adding authentication to an HTTP request.

ResponseConsumer

fun interface ResponseConsumer

A functional interface for functions that consume a HttpResponse and use it for side-effects.

ResponseMapper

fun interface ResponseMapper<T>

A functional interface for functions that map a HttpResponse to a desired result. // * See EntityUtils for useful methods for working with HttpEntity instances.

Properties

client

var client: <Error class: unknown class>

val cs: <Error class: unknown class>

Functions

fetch

suspend fun fetch(url: URL): ByteArrayInputStream

Makes a GET request to the given URL and returns the response body in a ByteArrayInputStream.

suspend fun fetch(url: URL, file: File)

Downloads a file from the given URL into the given file.

fetchAndConsume

suspend fun fetchAndConsume(url: URL, consumer: CoursesClient.ResponseConsumer)

Makes a GET request to the given URL and consumes the response.

fetchAndMap

suspend fun <T> fetchAndMap(url: URL, mapper: CoursesClient.ResponseMapper<T>): T

Makes a GET request to the given URL and returns the mapped response.

get

suspend fun get(url: String): <Error class: unknown class>

getBody

inline suspend fun <Resource : Any, Body : Any> getBody(resource: Resource): Body

inline suspend fun <Body : Any> getBody(url: String, snake: Boolean): Body

getFileSize

suspend fun getFileSize(url: URL): Long?

json

fun json(snake: Boolean = true): <Error class: unknown class>

post

suspend fun <T> post(url: URL, data: Map<String, Any>?, mapper: CoursesClient.ResponseMapper<T>): T?

Sends a POST request to the given URL and returns the value created by the mapper.

requireSuccessStatusCode

fun requireSuccessStatusCode(response: <Error class: unknown class>)

Throws a UnexpectedResponseException if the response status code isn't 2xx. If the response body includes JSON with an array for the key "errors" or a string for the key "detail", then those messages are included in the exception message.

updateAuthentication

fun updateAuthentication()