Class QueryObjectModel

Namespace

DuetAPI.Commands

Assembly

DuetAPI.dll

Query the object model using a key and flags, returning a formatted JSON response compatible with the M409 response format without going through the code execution pipeline

[RequiredPermissions(SbcPermissions.ObjectModelRead|SbcPermissions.ObjectModelReadWrite)]
public class QueryObjectModel : Command<JsonElement>

Inheritance

object

BaseCommand

Command<JsonElement>

QueryObjectModel

Derived

QueryObjectModel

Inherited Members

Command<JsonElement>.ExecuteAsync(CancellationToken)

Command<JsonElement>.InvokeAsync(CancellationToken)

BaseCommand.Command

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

QueryObjectModel()

public QueryObjectModel()

Properties

Flags

RRF-compatible flags string controlling response content: 'f' = only include live (frequently changing) properties, 'n' = include null values, 'v' = include verbose properties, 'o' = include obsolete properties, 'a' followed by digits = array start index, 'd' followed by digits = max depth

public string Flags { get; set; }

Property Value

string

Key

Object model key path to query (e.g. "heat", "move.axes", "" for root)

public string Key { get; set; }

Property Value

string

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