Class PluginPrerequisite
Represents a prerequisite for a Plugin or PluginFeature
Namespace: Artemis.Core
Assembly: Artemis.Core.dll
Syntax
public abstract class PluginPrerequisite : CorePropertyChanged
Constructors
PluginPrerequisite()
Declaration
protected PluginPrerequisite()
Properties
CurrentAction
Gets or sets the action currently being executed
Declaration
public PluginPrerequisiteAction? CurrentAction { get; }
Property Value
Type | Description |
---|---|
PluginPrerequisiteAction |
Description
Gets the description of the prerequisite
Declaration
public abstract string Description { get; }
Property Value
Type | Description |
---|---|
string |
InstallActions
Gets a list of actions to execute when Install(CancellationToken) is called
Declaration
public abstract List<PluginPrerequisiteAction> InstallActions { get; }
Property Value
Type | Description |
---|---|
List<PluginPrerequisiteAction> |
Name
Gets the name of the prerequisite
Declaration
public abstract string Name { get; }
Property Value
Type | Description |
---|---|
string |
Platform
Gets or sets the platform(s) this prerequisite applies to.
Declaration
public PluginPlatform? Platform { get; protected set; }
Property Value
Type | Description |
---|---|
PluginPlatform? |
UninstallActions
Gets a list of actions to execute when Uninstall(CancellationToken) is called
Declaration
public abstract List<PluginPrerequisiteAction> UninstallActions { get; }
Property Value
Type | Description |
---|---|
List<PluginPrerequisiteAction> |
Methods
AppliesToPlatform()
Determines whether this prerequisite applies to the current operating system.
Declaration
public bool AppliesToPlatform()
Returns
Type | Description |
---|---|
bool |
Install(CancellationToken)
Execute all install actions
Declaration
public Task Install(CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
CancellationToken | cancellationToken |
Returns
Type | Description |
---|---|
Task |
IsMet()
Called to determine whether the prerequisite is met
Declaration
public abstract bool IsMet()
Returns
Type | Description |
---|---|
bool |
OnInstallFinished()
Called after installation finishes
Declaration
protected virtual void OnInstallFinished()
OnInstallStarting()
Called before installation starts
Declaration
protected virtual void OnInstallStarting()
OnUninstallFinished()
Called after uninstall finished
Declaration
protected virtual void OnUninstallFinished()
OnUninstallStarting()
Called before uninstall starts
Declaration
protected virtual void OnUninstallStarting()
Uninstall(CancellationToken)
Execute all uninstall actions
Declaration
public Task Uninstall(CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
CancellationToken | cancellationToken |
Returns
Type | Description |
---|---|
Task |