Show / Hide Table of Contents

    Class CommandPaletteHandler

    Used to register a CommandPalette with a given . 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.

    Inheritance
    System.Object
    CommandPaletteHandler
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Petabridge.Cmd.Host
    Assembly: cs.temp.dll.dll
    Syntax
    public abstract class CommandPaletteHandler

    Constructors

    CommandPaletteHandler(CommandPalette)

    Declaration
    protected CommandPaletteHandler(CommandPalette palette)
    Parameters
    Type Name Description
    CommandPalette palette

    Properties

    HandlerProps

    The 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
    Back to top Generated by DocFX