Class CommandPaletteHandler
Used to register a CommandPalette with a given IActorRef. Any Command objects that are received by this host which are defined inside Palette will be routed to actor created via HandlerProps. Any commands defined inside a different CommandPalette will be routed to the appropriate CommandPaletteHandler by the petabridge.cmd.Host.
Inherited Members
Namespace: Petabridge.Cmd.Host
Assembly: Petabridge.Cmd.Host.dll
Syntax
public abstract class CommandPaletteHandlerConstructors
CommandPaletteHandler(CommandPalette)
Declaration
protected CommandPaletteHandler(CommandPalette palette)Parameters
| Type | Name | Description |
|---|---|---|
| CommandPalette | palette |
Properties
HandlerProps
The Props of the actor who will handle the messages.
Declaration
public abstract Props HandlerProps { get; }Property Value
| Type | Description |
|---|---|
| Props |
Remarks
One instance of the HandlerProps actor will be created per-connection. The actor will be terminated when that connection is closed.
Palette
The set of defined commands handled by HandlerProps
Declaration
public CommandPalette Palette { get; }Property Value
| Type | Description |
|---|---|
| CommandPalette |
Methods
OnRegister(PetabridgeCmd)
Called when registered by the PetabridgeCmd plugin.
Declaration
public virtual void OnRegister(PetabridgeCmd plugin)Parameters
| Type | Name | Description |
|---|---|---|
| PetabridgeCmd | plugin |