Knowledge Base - API
Breadcrumbs

Configuration

The Configuration class represents the session object for a client to interact with a configuration. Instances of this object are initialized by the Web Configurator Service and a reference is returned to the client.

Constructors

Configuration(bool generateXml = true)

Configuration(string lineItemXml)

Properties

Data Type

Property

Description

int

ID

Returns the numeric identifier (0-based) for the configuration line item. A value of -1 indicates that the configuration is new.

string

Xml

Returns the XML that represents the current line item. Note that this data may be compressed.

bool

HasErrors

Returns whether any errors exist in the current configuration. Not all error states represented have associated messages. For instance, a configuration saved with errors has the 'haserrors' flag set to true, but the configuration itself has no notion as to what the errors are.

bool

HasMessages

Returns whether any messages exist for the current configuration.

List<ConfigurationMessage>

Messages

Returns any messages associated with the current configuration.

bool

HasSettings

Returns whether any settings were returned for the current configuration.

List<ConfigurationSetting>

Settings

Returns any settings associated with the current configuration.

bool

HasDeferredRules

Returns whether there are any deferred messages associated with the current configuration.