Class HistoryExecutionCommand

Namespace

OverKizApi.Models

Assembly

OverKizApi.dll

A single command record within a HistoryExecution.

public sealed class HistoryExecutionCommand

Inheritance

object

HistoryExecutionCommand

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Properties

Command

Name of the command that was executed.

[JsonPropertyName("command")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Command { get; init; }

Property Value

string

DeviceUrl

URL of the device this command was addressed to.

[JsonPropertyName("deviceURL")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? DeviceUrl { get; init; }

Property Value

string

Dynamic

Whether this command was dynamically injected (not from a stored scenario).

[JsonPropertyName("dynamic")]
public bool Dynamic { get; init; }

Property Value

bool

FailureType

Failure type string for this command (see FailureType).

[JsonPropertyName("failureType")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? FailureType { get; init; }

Property Value

string

Parameters

Parameter values that were passed to the command.

[JsonPropertyName("parameters")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonConverter(typeof(DeviceValuesConverter))]
public IReadOnlyList<object?>? Parameters { get; init; }

Property Value

IReadOnlyList<object>

Rank

Zero-based rank of this command within the execution action group.

[JsonPropertyName("rank")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
public int Rank { get; init; }

Property Value

int

State

Terminal state reached by this specific command.

[JsonPropertyName("state")]
public ExecutionState State { get; init; }

Property Value

ExecutionState