Viv JavaScript Runtime - v0.10.2
    Preparing search index...

    Interface HostApplicationAdapterDebuggingSettings

    Configuration parameters controlling activation of the Viv runtime's debugging facilities.

    interface HostApplicationAdapterDebuggingSettings {
        callbacks?: HostApplicationAdapterObservabilityCallbacks;
        validateAPICalls?: boolean;
        watchlists?: HostApplicationAdapterConstructWatchlists;
    }
    Index

    Properties

    An object specifying observability callbacks to register with the Viv runtime.

    Observability callbacks cause the runtime to emit events that support real-time observability into processes such as action selection and plan execution. These events can be processed by the host application to drive debugging facilities pertaining to the Viv integration.

    Important: Observability callbacks slow down the runtime, and thus should only be used when the host application's Viv integration is being debugged or otherwise monitored.

    validateAPICalls?: boolean

    Whether to carry out structural validation (against a schema) of all calls to the Viv runtime's API functions (e.g., selectAction()).

    This will produce more informative error messages for malformed calls, at the cost of some overhead per call. As such, this setting is most useful during initial integration of Viv into a host application.

    An object identifying constructs to watch.

    When a construct is being watched, WatchedConstructDebuggingState is collected whenever it is targeted. This information can be used to investigate why a construct has not been successfully targeted, especially if this is due to something like a mistyped condition.