Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

SDK_API::requestInterfaceUi

Opens or updates a named interface workflow without blocking the plugin loop. The returned object contains a request_id which can be queried for its typed JSON result.

Declaration

virtual nlohmann::json requestInterfaceUi(
            const std::string& ui_id,
            nlohmann::json payload,
            nlohmann::json options = nlohmann::json::object()) {
            (void)ui_id;
            (void)payload;
            (void)options;
            return nlohmann::json::object();
        }

Parameters

Name	Description
`ui_id`	Plugin-local interface workflow identifier.
`payload`	Workflow request payload.
`options`	Optional workflow settings; severity is message (default), warning, or error.