Class WriteMessage

Namespace

DuetAPI.Commands

Assembly

DuetAPI.dll

Write an arbitrary generic message

[RequiredPermissions(SbcPermissions.CommandExecution|SbcPermissions.ObjectModelReadWrite)]
public class WriteMessage : Command

Inheritance

object

BaseCommand

Command

WriteMessage

Derived

WriteMessage

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

If neither OutputMessage is true, the message is written to the console output

Constructors

WriteMessage()

public WriteMessage()

Properties

Content

Content of the message to write

public string Content { get; set; }

Property Value

string

LogLevel

Log level of this message

public EventLogLevel? LogLevel { get; set; }

Property Value

EventLogLevel?

OutputMessage

Output the message on the console and via the object model

public bool OutputMessage { get; set; }

Property Value

bool

Type

Type of the message to write

public MessageType Type { get; set; }

Property Value

MessageType

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