Guilds/me.glaremasters.guilds.updater/UpdateChecker

UpdateChecker

class UpdateChecker(source)

A utility class to assist in checking for updates for plugins uploaded to SpigotMC. Before any members of this class are accessed, init must be invoked by the plugin, preferrably in its onEnable method, though that is not a requirement.

This class performs asynchronous queries to SpiGet, an REST server which is updated periodically. If the results of requestUpdateCheck are inconsistent with what is published on SpigotMC, it may be due to SpiGet's cache. Results will be updated in due time.

Author

Parker Hawke - 2008Choco

Types

enum UpdateReason

A constant reason for the result of UpdateResult.

class UpdateResult

Represents a result for an update query performed by requestUpdateCheck.

@FunctionalInterface

interface VersionScheme

A functional interface to compare two version Strings with similar version schemes.

Functions

open fun get(): UpdateChecker

Get the initialized instance of UpdateChecker.

open fun init(plugin: JavaPlugin, pluginID: Int): UpdateChecker

open fun init(plugin: JavaPlugin, pluginID: Int, versionScheme: UpdateChecker.VersionScheme): UpdateChecker

Initialize this update checker with the specified values and return its instance.

open fun isInitialized(): Boolean

Check whether the UpdateChecker has been initialized or not (if init has been invoked) and get is safe to use.

requestUpdateCheck

open fun requestUpdateCheck(): CompletableFuture<UpdateChecker.UpdateResult>

Request an update check to SpiGet.

open fun runCheck(guilds: Guilds, settingsManager: SettingsManager)

Run the update check for the plugin

open fun toInt(str: String, defaultValue: Int): Int

Properties

open val lastResult: UpdateChecker.UpdateResult

VERSION_SCHEME_DECIMAL

val VERSION_SCHEME_DECIMAL: UpdateChecker.VersionScheme