Class InstallPlugin

Namespace

DuetAPI.Commands

Assembly

DuetAPI.dll

Install or upgrade a plugin

[RequiredPermissions(SbcPermissions.ManagePlugins)]
public class InstallPlugin : Command

Inheritance

object

BaseCommand

Command

InstallPlugin

Derived

InstallPlugin

Inherited Members

Command.ExecuteAsync(CancellationToken)

Command.InvokeAsync(CancellationToken)

BaseCommand.Command

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

InstallPlugin()

public InstallPlugin()

Exceptions

ArgumentException

Plugin is incompatible

Properties

PluginFile

Absolute file path to the plugin ZIP bundle

public string PluginFile { get; set; }

Property Value

string

Exceptions

ArgumentException

Plugin is incompatible

Methods

UpdateFromJson(JsonElement)

Update this instance from a given JSON element

public override void UpdateFromJson(JsonElement jsonElement)

Parameters

jsonElement JsonElement

Element to update this intance from

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data

UpdateFromJsonReader(ref Utf8JsonReader)

Update this instance from a given JSON element

public override void UpdateFromJsonReader(ref Utf8JsonReader reader)

Parameters

reader Utf8JsonReader

Reader to update this intance from

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data