Class Command<T>

Namespace

DuetAPI.Commands

Assembly

DuetAPI.dll

Base class of a command that returns a result

public abstract class Command<T> : BaseCommand

Type Parameters

T

Type of the command result

Inheritance

object

BaseCommand

Command<T>

Derived

AddHttpEndpoint

AddUserSession

CheckPassword

Code

EvaluateExpression

Flush

GetFileInfo

GetObjectModel

QueryObjectModel

RemoveHttpEndpoint

RemoveUserSession

ResolvePath

ResolvePluginProcess

SetObjectModel

SimpleCode

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<T> ExecuteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Optional cancellation token

Returns

Task<T>

Command result

InvokeAsync(CancellationToken)

Invokes the command implementation

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

Parameters

cancellationToken CancellationToken

Optional cancellation token

Returns

Task<object>

Command result