Class Plugin

Namespace

DuetAPI.ObjectModel

Assembly

DuetAPI.dll

Class representing a loaded plugin

public class Plugin : PluginManifest, INotifyPropertyChanging, IStaticModelObject, IModelObject, ICloneable, INotifyPropertyChanged

Inheritance

object

ModelObject

PluginManifest

Plugin

Implements

INotifyPropertyChanging

IStaticModelObject

IModelObject

ICloneable

INotifyPropertyChanged

Inherited Members

PluginManifest.CheckVersion(string, string)

PluginManifest.Id

PluginManifest.Name

PluginManifest.Author

PluginManifest.Version

PluginManifest.License

PluginManifest.Homepage

PluginManifest.Tags

PluginManifest.DwcVersion

PluginManifest.DwcDependencies

PluginManifest.SbcRequired

PluginManifest.SbcDsfVersion

PluginManifest.SbcExecutable

PluginManifest.SbcExecutableArguments

PluginManifest.SbcExtraExecutables

PluginManifest.SbcAutoRestart

PluginManifest.SbcNotifyStarted

PluginManifest.SbcOutputRedirected

PluginManifest.SbcPermissions

PluginManifest.SbcConfigFiles

PluginManifest.SbcPackageDependencies

PluginManifest.SbcPythonDependencies

PluginManifest.SbcPluginDependencies

PluginManifest.RrfVersion

PluginManifest.Data

ModelObject.SetPropertyValue<T>(ref T, T, string)

ModelObject.PropertyChanging

ModelObject.PropertyChanged

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Plugin()

public Plugin()

Properties

DsfFiles

List of files for the DSF plugin

public ObservableCollection<string> DsfFiles { get; }

Property Value

ObservableCollection<string>

DwcFiles

List of files for the DWC plugin

public ObservableCollection<string> DwcFiles { get; }

Property Value

ObservableCollection<string>

Pid

Process ID of the plugin or -1 if not started. It is set to 0 while the plugin is being shut down

public int Pid { get; set; }

Property Value

int

SdFiles

List of files to be installed to the (virtual) SD excluding web files

public ObservableCollection<string> SdFiles { get; }

Property Value

ObservableCollection<string>

Started

Indicates if the plugin is fully started

public bool Started { get; set; }

Property Value

bool

Methods

Assign(IStaticModelObject)

Assign the properties from another instance. This is required to update model properties which do not have a setter

public override void Assign(IStaticModelObject from)

Parameters

from IStaticModelObject

Other instance

Clone()

Clone this instance

public override object Clone()

Returns

object

Cloned instance

Remarks

This method is auto-generated

UpdateFromJson(JsonElement, bool)

Update this instance from a given JSON element

public override void UpdateFromJson(JsonElement jsonElement, bool ignoreSbcProperties)

Parameters

jsonElement JsonElement

Element to update this intance from

ignoreSbcProperties bool

Whether SBC properties are ignored

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data

UpdateFromJsonReader(ref Utf8JsonReader, bool)

Update this instance from a given JSON element

public override void UpdateFromJsonReader(ref Utf8JsonReader reader, bool ignoreSbcProperties)

Parameters

reader Utf8JsonReader

Reader to update this intance from

ignoreSbcProperties bool

Whether SBC properties are ignored

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data