Table of Contents

Struct PluginChatInputDecision

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

The answer an input interceptor gives for one typed line. Build it from Pass, Suppress or Rewrite(string); the default value is Pass.

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

Properties

Action

What to do with the line.

public PluginChatInputAction Action { get; }

Property Value

PluginChatInputAction

Pass

Leave the line alone.

public static PluginChatInputDecision Pass { get; }

Property Value

PluginChatInputDecision

Suppress

Drop the line without sending it anywhere.

public static PluginChatInputDecision Suppress { get; }

Property Value

PluginChatInputDecision

Text

The replacement line when Action is Rewrite; null otherwise.

public string? Text { get; }

Property Value

string

Methods

Rewrite(string)

Replace the line with text. A blank replacement is treated as Suppress by the host.

public static PluginChatInputDecision Rewrite(string text)

Parameters

text string

The line to send instead of what was typed.

Returns

PluginChatInputDecision