Class SetPluginData

Namespace

DuetAPI.Commands

Assembly

DuetAPI.dll

Update custom plugin data in the object model

[RequiredPermissions(SbcPermissions.ObjectModelReadWrite)]
public class SetPluginData : Command

Inheritance

object

BaseCommand

Command

SetPluginData

Derived

SetPluginData

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()

Remarks

May be used to update only the own plugin data unless the plugin has the ManagePlugins permission. Note that the corresponding key must already exist in the plugin data!

Constructors

SetPluginData()

public SetPluginData()

Exceptions

ArgumentException

Invalid plugin name or data key specified

Properties

Key

Key to set

public string Key { get; set; }

Property Value

string

Remarks

This key must already exist in the Data object!

Exceptions

ArgumentException

Invalid plugin name or data key specified

Plugin

Identifier of the plugin to update (only mandatory if running as root)

public string? Plugin { get; set; }

Property Value

string

Exceptions

ArgumentException

Invalid plugin name or data key specified

Value

Custom value to set

public JsonElement Value { get; set; }

Property Value

JsonElement

Exceptions

ArgumentException

Invalid plugin name or data key specified

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