API Reference

API Reference#

This section provides detailed documentation for all APIs available in the Paramus Extension Framework.

Core Classes#

Host Process#

API Classes#

ExtensionRegistry#

MessageTerminal#

UIBridge#

JSON-RPC Methods#

The following JSON-RPC methods are available through the host process. All methods use the current copilot.* naming convention:

API Documentation Methods#

  • api.describe - Get comprehensive documentation for all extension classes

Test Methods#

  • copilot.test.hello - Print hello world message from UI test class

  • copilot.test.run - Execute UI test class run method

Core Test Methods#

  • core.test.hello - Print hello world message from core test class

  • core.test.run - Execute core test class run method

Terminal Methods#

  • copilot.sendmessage.terminal - Send message to terminal with full control options

  • copilot.quicksend.terminal - Quickly send message to terminal without WebSocket waiting

UI Control Methods#

  • copilot.trigger.button - Trigger any UI button by its ID

  • copilot.trigger.new - Trigger the ‘new’ button in the UI

  • copilot.trigger.sync - Trigger file tree synchronization

  • copilot.send.notification - Show notification popup to the user

  • copilot.update.element - Update DOM element properties dynamically

Alternative UI Methods (Equivalent functionality)#

  • copilot.ui.trigger.button - Alternative to copilot.trigger.button

  • copilot.ui.trigger.new - Alternative to copilot.trigger.new

  • copilot.ui.trigger.sync - Alternative to copilot.trigger.sync

  • copilot.ui.send.notification - Alternative to copilot.send.notification

  • copilot.ui.update.element - Alternative to copilot.update.element

Method Parameters#

Terminal Methods#

  • copilot.sendmessage.terminal:

    • content (string, required): The message content to send

    • wait_for_ws (boolean, optional, default: true): Whether to wait for websocket connection

    • retry_interval (float, optional, default: 1.0): Retry interval for websocket connection

  • copilot.quicksend.terminal:

    • content (string, required): The message content to send

UI Control Methods#

  • copilot.trigger.button:

    • button_id (string, required): The ID of the button to trigger

  • copilot.send.notification:

    • message (string, required): The notification message to display

  • copilot.update.element:

    • element_id (string, required): The ID of the element to update

    • property (string, required): Property to update (textContent, innerHTML, value, style)

    • value (any, required): New value for the property

Contents