Class MessageTransformPlugin

Message Transform Plugin Implementation

Implements

Index

Constructors

constructor

new MessageTransformPlugin(): MessageTransformPlugin
Returns MessageTransformPlugin

Methods

onLoad

onLoad(context: PluginContext): Promise<void>
Plugin lifecycle hooks
Parameters
- context: PluginContext
Returns Promise<void>
Implementation of Plugin.onLoad
- Defined in plugins/examples/MessageTransformPlugin.ts:89

onEnable

onEnable(context: PluginContext): Promise<void>
Called when plugin is enabled
Parameters
- context: PluginContext
Returns Promise<void>
Implementation of Plugin.onEnable
- Defined in plugins/examples/MessageTransformPlugin.ts:96

onDisable

onDisable(context: PluginContext): Promise<void>
Called when plugin is disabled
Parameters
- context: PluginContext
Returns Promise<void>
Implementation of Plugin.onDisable
- Defined in plugins/examples/MessageTransformPlugin.ts:105

onUnload

onUnload(context: PluginContext): Promise<void>
Called when plugin is unloaded
Parameters
- context: PluginContext
Returns Promise<void>
Implementation of Plugin.onUnload
- Defined in plugins/examples/MessageTransformPlugin.ts:112

onConfigChange

onConfigChange(context: PluginContext): Promise<void>
Called when Conciergus configuration changes
Parameters
- context: PluginContext
Returns Promise<void>
Implementation of Plugin.onConfigChange
- Defined in plugins/examples/MessageTransformPlugin.ts:119

processMessage

processMessage(
message: EnhancedUIMessage,
context: PluginContext,
): Promise<EnhancedUIMessage>
Message processing methods
Parameters
- message: EnhancedUIMessage
- context: PluginContext
Returns Promise<EnhancedUIMessage>
Implementation of MessagePlugin.processMessage
- Defined in plugins/examples/MessageTransformPlugin.ts:129

processOutgoingMessage

processOutgoingMessage(
message: EnhancedUIMessage,
context: PluginContext,
): Promise<EnhancedUIMessage>
Process outgoing messages
Parameters
- message: EnhancedUIMessage
- context: PluginContext
Returns Promise<EnhancedUIMessage>
Implementation of MessagePlugin.processOutgoingMessage
- Defined in plugins/examples/MessageTransformPlugin.ts:198

transformMetadata

transformMetadata(
metadata: MessageMetadata,
context: PluginContext,
): Promise<MessageMetadata>
Transform message metadata
Parameters
- metadata: MessageMetadata
- context: PluginContext
Returns Promise<MessageMetadata>
Implementation of MessagePlugin.transformMetadata
- Defined in plugins/examples/MessageTransformPlugin.ts:225

Properties

metadata

metadata: {
    id: string;
    name: string;
    version: string;
    description: string;
    author: { name: string; email: string };
    keywords: string[];
    license: string;
} = ...

Plugin metadata

defaultConfig

defaultConfig: {
    enabled: boolean;
    priority: number;
    options: MessageTransformConfig;
} = ...

Default plugin configuration

configSchema

configSchema: {
    type: string;
    required: string[];
    properties: {
        enableEmojiReplacement: { type: string };
        enableTextFormatting: { type: string };
        enableProfanityFilter: { type: string };
        customReplacements: { type: string };
        maxMessageLength: { type: string; minimum: number };
    };
} = ...

Plugin configuration schema

Class MessageTransformPlugin

Implements

Index

Constructors

Methods

Properties

Constructors

constructor

Returns MessageTransformPlugin

Methods

onLoad

Parameters

Returns Promise<void>

onEnable

Parameters

Returns Promise<void>

onDisable

Parameters

Returns Promise<void>

onUnload

Parameters

Returns Promise<void>

onConfigChange

Parameters

Returns Promise<void>

processMessage

Parameters

Returns Promise<EnhancedUIMessage>

processOutgoingMessage

Parameters

Returns Promise<EnhancedUIMessage>

transformMetadata

Parameters

Returns Promise<MessageMetadata>

Properties

metadata

defaultConfig

configSchema

Settings

On This Page