Table of Contents

Struct PluginItemCommandResult

Namespace
AcDream.Plugin.Abstractions
Assembly
AcDream.Plugin.Abstractions.dll

The outcome of one item command, with an optional explanation.

public readonly record struct PluginItemCommandResult : IEquatable<PluginItemCommandResult>
Implements
Inherited Members

Constructors

PluginItemCommandResult(PluginItemCommandStatus, string?)

The outcome of one item command, with an optional explanation.

public PluginItemCommandResult(PluginItemCommandStatus Status, string? Notice = null)

Parameters

Status PluginItemCommandStatus

What the client did with the command.

Notice string

A short human-readable reason, when there is one.

Properties

Accepted

True when the request actually went out to the server.

public bool Accepted { get; }

Property Value

bool

Notice

A short human-readable reason, when there is one.

public string? Notice { get; init; }

Property Value

string

Status

What the client did with the command.

public PluginItemCommandStatus Status { get; init; }

Property Value

PluginItemCommandStatus