Interface PromptAssistFactory


public interface PromptAssistFactory
Hands out the reusable host-agnostic @-reference browsers Designer assist surfaces commonly mount. Obtained through DesignerAiContext.promptAssists().
  • Method Details

    • tags

      Default-configured TagPromptAssist for the tag system. Atomic tags insert @tag:[provider]path/to/tag references; folders are both insertable (carrying a snapshot of their children's values) and expandable. Hides the client provider; for other provider visibility, build one with TagPromptAssist.builder(DesignerContext).
      See Also:
    • files

      Browser for the open project's file-resource tree. Text files insert @file:path references whose bodies carry a snapshot of the file's content at the moment the user selects the row. Binary resources are hidden.
    • opc

      Browser for the gateway's OPC connections. Nodes insert @opc:server/nodeId references describing the node's identity and browse metadata; the references are source context only and never imply a live read or write.
    • systemLibrary

      SystemLibraryPromptAssist systemLibrary()
      Browser for Ignition's system.* scripting library. Functions and constants insert @system:path references whose bodies carry the symbol's documentation; packages are expandable. Reflects the Designer execution scope — see SystemLibraryPromptAssist to browse a different scope.
    • userLibrary

      Browser for the open project's user script library. Functions, classes, and values insert @library:path references carrying their documentation; whole script modules are also insertable (body carries a source snapshot) and expandable.
    • datasource

      Browser for the gateway's database connections, drilling from datasources into tables into columns. Selections insert @datasource:path references identifying a datasource, table, or column; the assist never implies a live query.