core/it.maicol07.spraypaintkt/Resource/CompanionObj

CompanionObj

interface CompanionObj<R : Resource>(source)

A companion object for the resource.

Parameters

R

The type of the resource.

Properties

abstract val config: JsonApiConfig

The configuration of the resource.

abstract val endpoint: String

The endpoint of the resource.

abstract val factory: () -> R

The factory for the resource.

abstract val resourceType: String

The type of the resource.

abstract val schema: KClass<*>

The schema of the resource.

Functions

open fun fromJsonApi(jsonApiResponse: JsonApiSingleResponse)

open fun fromJsonApi(jsonApiData: JsonApiResource, included: List<JsonApiResource>)

Deserialize the resource from a JSON:API response.

open fun urlForResource(resource: Resource? = null, id: String? = null): String

Create a new instance of the resource.