Interface StartCommand

vosStartCommand - Host->Schemer: Host sends variables and optional coding scheme.

The variables list is the foundation of all coding – the schemer cannot function without it. sessionId is required and must be echoed back in every subsequent vosSchemeChangedNotification.

interface StartCommand {
    sessionId: string;
    codingScheme?: string;
    codingSchemeType?: string;
    variables?: MainSchema.VariableInfo[];
    schemerConfig?: MainSchema.SchemerConfig;
}

Hierarchy (view full)

Properties

sessionId codingScheme? codingSchemeType? variables? schemerConfig?

Properties

sessionId

sessionId: string

Required. Used to associate all subsequent messages with this unit.

OptionalcodingScheme

codingScheme?: string

The coding scheme to be edited (if any). Passed as a serialised string (format: byte).

OptionalcodingSchemeType

codingSchemeType?: string

Identifies the format/version of the coding scheme. Helps the schemer avoid UI issues when loading older schemes.

Optionalvariables

variables?: MainSchema.VariableInfo[]

Variables from the unit definition. These represent control states during assessment and are the basis for coding.

OptionalschemerConfig

schemerConfig?: MainSchema.SchemerConfig

Schemer-specific configuration

Settings

Member Visibility

On This Page

Properties