Table of Contents

Class PluginPrerequisiteAction

Namespace
Artemis.Core
Assembly
Artemis.Core.dll

Represents an action that must be taken to install or uninstall a plugin prerequisite

public abstract class PluginPrerequisiteAction : CorePropertyChanged
Inheritance
object
CorePropertyChanged
PluginPrerequisiteAction
Derived

Constructors

PluginPrerequisiteAction(string)

The base constructor for all plugin prerequisite actions

protected PluginPrerequisiteAction(string name)

Parameters

name string

The name of the action

Properties

Name

Gets the name of the action

public string Name { get; }

Property Value

string

Progress

Gets or sets the progress of the action (0 to 100)

public PrerequisiteActionProgress Progress { get; }

Property Value

PrerequisiteActionProgress

ProgressIndeterminate

Gets or sets a boolean indicating whether the progress is indeterminate or not

public bool ProgressIndeterminate { get; set; }

Property Value

bool

ShowProgressBar

Gets or sets a boolean indicating whether the progress bar should be shown

public bool ShowProgressBar { get; set; }

Property Value

bool

ShowSubProgressBar

Gets or sets a boolean indicating whether the sub progress bar should be shown

public bool ShowSubProgressBar { get; set; }

Property Value

bool

Status

Gets or sets the status of the action

public string? Status { get; set; }

Property Value

string

SubProgress

Gets or sets the sub progress of the action

public PrerequisiteActionProgress SubProgress { get; }

Property Value

PrerequisiteActionProgress

SubProgressIndeterminate

Gets or sets a boolean indicating whether the progress is indeterminate or not

public bool SubProgressIndeterminate { get; set; }

Property Value

bool

Methods

Execute(CancellationToken)

Called when the action must execute

public abstract Task Execute(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task