Class InstallPlugin

Namespace

DuetControlServer.Commands

Assembly

DuetControlServer.dll

Implementation of the InstallPlugin command

public sealed class InstallPlugin : InstallPlugin

Inheritance

object

BaseCommand

Command

InstallPlugin

InstallPlugin

Inherited Members

InstallPlugin.UpdateFromJson(JsonElement)

InstallPlugin.UpdateFromJsonReader(ref Utf8JsonReader)

InstallPlugin.PluginFile

Command.InvokeAsync(CancellationToken)

BaseCommand.Command

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

InstallPlugin(CommandFactory, ObjectModel, IOptions<Settings>)

Implementation of the InstallPlugin command

public InstallPlugin(CommandFactory commandFactory, ObjectModel model, IOptions<Settings> settings)

Parameters

commandFactory CommandFactory

Command factory

model ObjectModel

Object model

settings IOptions<Settings>

Settings

Properties

Upgrade

Internal flag to indicate that custom plugin files should not be purged

public bool Upgrade { get; set; }

Property Value

bool

Methods

ExecuteAsync(CancellationToken)

Install or upgrade a plugin

public override Task ExecuteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Optional cancellation token

Returns

Task

Asynchronous task

Exceptions

ArgumentException

Plugin is incompatible