Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

SDK_API::promptString

Block the calling thread until a text response arrives.

Uses the DCode argument order and graph syntax. No firing timeout; completion ends firing. Acknowledgement or stop_event_firing does not complete the wait. May allocate, lock, and wait indefinitely. Unlike a DCode timeline prompt, a C++ SDK call blocks its invoking thread.

Declaration

virtual std::string promptString(const std::string& title, const std::string& description,
            nlohmann::json channels = nlohmann::json::array(), const std::string& resolution = "",
            int auto_acknowledge = 0, const std::string& system = "SOFTWARE",
            const std::string& subsystem = "DCODE") {
            throw std::runtime_error("ARGUS promptString is not supported by this host.");
        }

Parameters

Name	Description
`title`	Workflow title.
`description`	Operator-facing body text.
`channels`	Flat series or nested graph groups, as in DCode.
`resolution`	Recommended operator action.
`auto_acknowledge`	Seconds before visual acknowledgement; zero disables it.
`system`	ARGUS system grouping; defaults to SOFTWARE.
`subsystem`	ARGUS subsystem grouping; defaults to DCODE.

Returns

Operator text response. Unsupported hosts and workflow failures throw.