Class StartPlugin

Namespace

DuetControlServer.Commands

Assembly

DuetControlServer.dll

Implementation of the StartPlugin command

public sealed class StartPlugin : StartPlugin

Inheritance

object

BaseCommand

Command

StartPlugin

StartPlugin

Inherited Members

StartPlugin.UpdateFromJson(JsonElement)

StartPlugin.UpdateFromJsonReader(ref Utf8JsonReader)

StartPlugin.Plugin

StartPlugin.SaveState

Command.InvokeAsync(CancellationToken)

BaseCommand.Command

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

StartPlugin(CommandFactory, ObjectModel, IOptions<Settings>)

Implementation of the StartPlugin command

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

Parameters

commandFactory CommandFactory

Command factory

model ObjectModel

Object model

settings IOptions<Settings>

Settings

Properties

IsAnyStarting

True while at least one StartPlugin command is currently executing

public static bool IsAnyStarting { get; }

Property Value

bool

Methods

ExecuteAsync(CancellationToken)

Start a plugin

public override Task ExecuteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Optional cancellation token

Returns

Task

Asynchronous task

Exceptions

ArgumentException

Plugin is invalid