Class IChatToolRegistry

Registry interface for discovering and executing registered ChatTool plugins.

Hierarchy (View Summary)

IPluginComponent
- IChatToolRegistry

Index

Constructors

Properties

interfaceId toolDeregistered toolRegistered tools

Methods

execute getTypeName isOfType isSame

Constructors

`Protected`constructor

new IChatToolRegistry(): IChatToolRegistry
Snap Hidden
Returns IChatToolRegistry
Overrides IPluginComponent.constructor

Properties

`Static`interfaceId

interfaceId: InterfaceId

Unique identifier used to look up this interface via the plugin system.

`Readonly`toolDeregistered

toolDeregistered: signal1<IPluginDescriptor, void>

Signal emitted when a chat tool plugin is unregistered from the registry.

`Readonly`toolRegistered

toolRegistered: signal1<IPluginDescriptor, void>

Signal emitted when a new chat tool plugin is registered.

`Readonly`tools

tools: IPluginDescriptor[]

Array of all currently registered chat tool plugin descriptors.

Methods

execute

execute(descriptor: IPluginDescriptor, parameters: Parameters): Promise<Result>
Execute a registered chat tool by its plugin descriptor with the given parameters.
Parameters
- descriptor: IPluginDescriptor
- parameters: Parameters
Returns Promise<Result>

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from IPluginComponent.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object is of the specified type.
Parameters
- type: string
Returns boolean
Inherited from IPluginComponent.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object refers to the same instance as the given object.
Parameters
- other: ScriptObject
Returns boolean
Inherited from IPluginComponent.isSame