Class Command

Namespace

DuetAPI.Commands

Assembly

DuetAPI.dll

Base class of commands that do not return a result

public abstract class Command : BaseCommand

Inheritance

object

BaseCommand

Command

Derived

Acknowledge

Cancel

Ignore

InstallPlugin

InstallSystemPackage

InvalidateChannel

LockObjectModel

NotifyPluginStarted

PatchObjectModel

ReloadPlugin

Resolve

Rewrite

SetNetworkProtocol

SetPluginData

SetPluginProcess

SetUpdateStatus

StartPlugin

StartPlugins

StopPlugin

StopPlugins

SyncObjectModel

UninstallPlugin

UninstallSystemPackage

UnlockObjectModel

WriteMessage

Inherited Members

BaseCommand.UpdateFromJson(JsonElement)

BaseCommand.UpdateFromJsonReader(ref Utf8JsonReader)

BaseCommand.Command

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Command()

protected Command()

Methods

ExecuteAsync(CancellationToken)

Reserved for the actual command implementation in the control server

public virtual Task ExecuteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Optional cancellation token

Returns

Task

Asynchronous task

InvokeAsync(CancellationToken)

Invokes the command implementation

public override Task<object?> InvokeAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Optional cancellation token

Returns

Task<object>

null