Interface SchemeChangedNotificationData

Data for the scheme-changed notification sent to host

interface SchemeChangedNotificationData {
    sessionId: string;
    timeStamp: string;
    codingScheme?: string;
    codingSchemeType?: string;
    dependenciesToCode?: MainSchema.Dependency[];
    sharedParameters?: MainSchema.SharedParameter[];
}

Hierarchy (view full)

Properties

sessionId timeStamp codingScheme? codingSchemeType? dependenciesToCode? sharedParameters?

Properties

sessionId

sessionId: string

Session ID from the start command. Required for correct unit association.

timeStamp

timeStamp: string

ISO 8601 date-time string. Used to order asynchronously arriving messages.

OptionalcodingScheme

codingScheme?: string

The complete, updated coding scheme serialised as a string. The host stores this for later use by a coder.

OptionalcodingSchemeType

codingSchemeType?: string

Identifies the format/version of the coding scheme. Helps the host (and future coders) interpret the scheme correctly.

OptionaldependenciesToCode

dependenciesToCode?: MainSchema.Dependency[]

External files or services that must be available when coding responses. The host must ensure these dependencies are accessible during coding.

OptionalsharedParameters

sharedParameters?: MainSchema.SharedParameter[]

Shared parameters for cross-module data exchange.

Settings

Member Visibility

On This Page

Properties