Updater/io.github.vxrpenter.updater.upstream/Upstream

Upstream

interface Upstream : Comparable<Upstream>

The Upstream interface defines a remote that stores version information (and possible version files) that allows the fetching of this information through an api.

Inheritors

Properties

Link copied to clipboard
abstract val baseUrl: String?

The url that is used as a base for all api requests

Link copied to clipboard
abstract val baseUrlEndpoint: String?

The endpoint from where the data is requested [baseUrl+baseUrlEndpoint]

Link copied to clipboard
abstract val releaseBaseUrl: String?

The url that is used as a base for all releases

Link copied to clipboard
abstract val releaseBaseUrlEndpoint: String?

The endpoint where the release should lead to [baseUrl+baseUrlEndpoint]

Link copied to clipboard
abstract val upstreamPriority: Priority

Priority is that used when comparing versions from multiple upstreams.

Functions

Link copied to clipboard
open operator override fun compareTo(other: Upstream): Int
Link copied to clipboard
abstract suspend fun fetch(client: HttpClient, schema: UpdateSchema): Version?

Fetches a version object from the upstream.

Link copied to clipboard
abstract fun toVersion(version: String, schema: UpdateSchema): Version

Converts a version string into a Version.

Link copied to clipboard
abstract fun update(version: Version): Update

Returns an Update from a Version.