Table of Contents

Class PluginPrerequisite

Namespace
Artemis.Core
Assembly
Artemis.Core.dll

Represents a prerequisite for a Plugin or PluginFeature

public abstract class PluginPrerequisite : CorePropertyChanged
Inheritance
object
CorePropertyChanged
PluginPrerequisite

Properties

CurrentAction

Gets or sets the action currently being executed

public PluginPrerequisiteAction? CurrentAction { get; }

Property Value

PluginPrerequisiteAction

Description

Gets the description of the prerequisite

public abstract string Description { get; }

Property Value

string

InstallActions

Gets a list of actions to execute when Install(CancellationToken) is called

public abstract List<PluginPrerequisiteAction> InstallActions { get; }

Property Value

List<PluginPrerequisiteAction>

Name

Gets the name of the prerequisite

public abstract string Name { get; }

Property Value

string

Platform

Gets or sets the platform(s) this prerequisite applies to.

public PluginPlatform? Platform { get; protected set; }

Property Value

PluginPlatform?

UninstallActions

Gets a list of actions to execute when Uninstall(CancellationToken) is called

public abstract List<PluginPrerequisiteAction> UninstallActions { get; }

Property Value

List<PluginPrerequisiteAction>

Methods

AppliesToPlatform()

Determines whether this prerequisite applies to the current operating system.

public bool AppliesToPlatform()

Returns

bool

Install(CancellationToken)

Execute all install actions

public Task Install(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task

IsMet()

Called to determine whether the prerequisite is met

public abstract bool IsMet()

Returns

bool

true if the prerequisite is met; otherwise false

OnInstallFinished()

Called after installation finishes

protected virtual void OnInstallFinished()

OnInstallStarting()

Called before installation starts

protected virtual void OnInstallStarting()

OnUninstallFinished()

Called after uninstall finished

protected virtual void OnUninstallFinished()

OnUninstallStarting()

Called before uninstall starts

protected virtual void OnUninstallStarting()

Uninstall(CancellationToken)

Execute all uninstall actions

public Task Uninstall(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task