Interface IUpdaterPlugin

Namespace

Whim.Updater

Assembly

Whim.Updater.dll

UpdaterPlugin checks for updates to Whim and installs them, according to the given UpdaterConfig.

public interface IUpdaterPlugin : IPlugin, IDisposable

Inherited Members

IPlugin.Name

IPlugin.PreInitialize()

IPlugin.PostInitialize()

IPlugin.PluginCommands

IPlugin.LoadState(JsonElement)

IPlugin.SaveState()

IDisposable.Dispose()

Properties

Config

The configuration for the updater.

UpdaterConfig Config { get; }

Property Value

UpdaterConfig

LastCheckedForUpdates

The date and time that the updater last checked for updates.

DateTime? LastCheckedForUpdates { get; }

Property Value

DateTime?

SkippedReleaseTagName

The latest release that the user has chosen to skip.

string? SkippedReleaseTagName { get; }

Property Value

string

Methods

CheckForUpdates(bool)

Checks for updates. If there are updates, shows the updater window.

Task CheckForUpdates(bool notifyIfNoUpdates = true)

Parameters

notifyIfNoUpdates bool

Whether to show a notification if there are no updates. Default is true.

Returns

Task

SkipRelease(string?)

Skips the release with the given tag name.

void SkipRelease(string? tagName = null)

Parameters

tagName string

The tag name of the release to skip. If null, skips the latest release.