Class SetPluginData

Update custom plugin data in the object model

Inheritance

object

BaseCommand

Command

SetPluginData

SetPluginData

Inherited Members

Command.Execute()

Command.Invoke()

BaseCommand.Command

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: DuetAPI.Commands

Assembly: DuetAPI.dll

Syntax

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

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!

Properties

Key

Key to set

Declaration

public string Key { get; set; }

Property Value

Type	Description
string

Remarks

This key must already exist in the Data object!

Exceptions

Type	Condition
ArgumentException	Invalid plugin name or data key specified

Plugin

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

Declaration

public string? Plugin { get; set; }

Property Value

Type	Description
string

Exceptions

Type	Condition
ArgumentException	Invalid plugin name or data key specified

Value

Custom value to set

Declaration

public JsonElement Value { get; set; }

Property Value

Type	Description
JsonElement

Exceptions

Type	Condition
ArgumentException	Invalid plugin name or data key specified