Class ExtractArchiveAction
Represents a plugin prerequisite action that extracts a ZIP file
Inherited Members
Namespace: Artemis.Core
Assembly: Artemis.Core.dll
Syntax
public class ExtractArchiveAction : PluginPrerequisiteAction
Constructors
ExtractArchiveAction(string, string, string)
Creates a new instance of ExtractArchiveAction.
Declaration
public ExtractArchiveAction(string name, string fileName, string target)
Parameters
Type | Name | Description |
---|---|---|
string | name | The name of the action |
string | fileName | The ZIP file to extract |
string | target | The folder into which to extract the file |
Properties
FileName
Gets the file to extract
Declaration
public string FileName { get; }
Property Value
Type | Description |
---|---|
string |
FilesToExtract
Gets or sets an optional list of files to extract, if null all files will be extracted.
Declaration
public List<string>? FilesToExtract { get; set; }
Property Value
Type | Description |
---|---|
List<string> |
Target
Gets the folder into which to extract the file
Declaration
public string Target { get; }
Property Value
Type | Description |
---|---|
string |
Methods
Execute(CancellationToken)
Called when the action must execute
Declaration
public override Task Execute(CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
CancellationToken | cancellationToken |
Returns
Type | Description |
---|---|
Task |