0.1.0

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

GitHubUpstream

data class GitHubUpstream(val user: String, val repo: String, val baseUrl: String? = "https://api.github.com/", val baseUrlEndpoint: String? = "repos/", val releaseBaseUrl: String? = "https://github.com/", val releaseBaseUrlEndpoint: String? = "/", val upstreamPriority: Priority = 0.priority) : Upstream

The GitHub upstream.

Constructors

constructor(user: String, repo: String, baseUrl: String? = "https://api.github.com/", baseUrlEndpoint: String? = "repos/", releaseBaseUrl: String? = "https://github.com/", releaseBaseUrlEndpoint: String? = "/", upstreamPriority: Priority = 0.priority)

Properties

open override val baseUrl: String?

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

baseUrlEndpoint

open override val baseUrlEndpoint: String?

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

open override val releaseBaseUrl: String?

The url that is used as a base for all releases

releaseBaseUrlEndpoint

open override val releaseBaseUrlEndpoint: String?

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

val repo: String

Name of the repository

upstreamPriority

open override val upstreamPriority: Priority

Priority is that used when comparing versions from multiple upstreams.

val user: String

User that the repository resides under

Functions

open operator override fun compareTo(other: Upstream): Int

open suspend override fun fetch(client: HttpClient, schema: UpdateSchema): DefaultVersion?

Fetches a version object from the upstream.

open override fun toVersion(version: String, schema: UpdateSchema): DefaultVersion

Converts a version string into a DefaultVersion.

open override fun update(version: Version): Update

Returns an Update from a DefaultVersion.