Class PluginPrerequisiteAction
Represents an action that must be taken to install or uninstall a plugin prerequisite
Inheritance
PluginPrerequisiteAction
Namespace: Artemis.Core
Assembly: Artemis.Core.dll
Syntax
public abstract class PluginPrerequisiteAction : CorePropertyChangedConstructors
PluginPrerequisiteAction(string)
The base constructor for all plugin prerequisite actions
Declaration
protected PluginPrerequisiteAction(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the action |
Properties
Name
Gets the name of the action
Declaration
public string Name { get; }Property Value
| Type | Description |
|---|---|
| string |
Progress
Gets or sets the progress of the action (0 to 100)
Declaration
public PrerequisiteActionProgress Progress { get; }Property Value
| Type | Description |
|---|---|
| PrerequisiteActionProgress |
ProgressIndeterminate
Gets or sets a boolean indicating whether the progress is indeterminate or not
Declaration
public bool ProgressIndeterminate { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
ShowProgressBar
Gets or sets a boolean indicating whether the progress bar should be shown
Declaration
public bool ShowProgressBar { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
ShowSubProgressBar
Gets or sets a boolean indicating whether the sub progress bar should be shown
Declaration
public bool ShowSubProgressBar { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Status
Gets or sets the status of the action
Declaration
public string? Status { get; set; }Property Value
| Type | Description |
|---|---|
| string |
SubProgress
Gets or sets the sub progress of the action
Declaration
public PrerequisiteActionProgress SubProgress { get; }Property Value
| Type | Description |
|---|---|
| PrerequisiteActionProgress |
SubProgressIndeterminate
Gets or sets a boolean indicating whether the progress is indeterminate or not
Declaration
public bool SubProgressIndeterminate { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Methods
Execute(CancellationToken)
Called when the action must execute
Declaration
public abstract Task Execute(CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task |