Class PatchObjectModel

Namespace

DuetAPI.Commands

Assembly

DuetAPI.dll

Apply a full patch to the object model. May be used only in non-SPI mode

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

Inheritance

object

BaseCommand

Command

PatchObjectModel

Derived

PatchObjectModel

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

PatchObjectModel()

public PatchObjectModel()

Exceptions

ArgumentException

Invalid key specified

InvalidOperationException

DCS is not running in non-SPI mode

Properties

Key

Key to update

public string Key { get; set; }

Property Value

string

Exceptions

ArgumentException

Invalid key specified

InvalidOperationException

DCS is not running in non-SPI mode

Patch

JSON patch to apply

public JsonElement Patch { get; set; }

Property Value

JsonElement

Exceptions

ArgumentException

Invalid key specified

InvalidOperationException

DCS is not running in non-SPI mode

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

See Also

LockObjectModel

UnlockObjectModel