Click or drag to resize

ConfigurationDomain Class

Defines a configuration domain for use in the generic json configuration editor.
Inheritance Hierarchy
SystemObject
  MFiles.VAF.Configuration.DomainConfigurationDomain

Namespace:  MFiles.VAF.Configuration.Domain
Assembly:  MFiles.VAF.Configuration (in MFiles.VAF.Configuration.dll) Version: 2.2.0.9
Syntax
C#
[SerializableAttribute]
public class ConfigurationDomain

The ConfigurationDomain type exposes the following members.

Constructors
  NameDescription
Public methodConfigurationDomain
Top
Properties
  NameDescription
Public propertyCommands
The domain's custom commands if any.
Public propertyConfiguration
The domain's configuration source (readable/writable) if any.
Public propertyDescription
Optional description of the configuration domain.
Public propertyDisplayName
Human-readable name for the domain.
Public propertyID
Defines the id for the configuration domain. Should be unique (name-spaced name recommended).
Public propertyInitializers
Directives used to initialize the domain on the client. This can be used to package the domain with the results of domain definied sources, without the client needing to follow those sources itself initially. This can reduce the number of server calls that need to be made when first loading a domain, improving performance, especially in cases of high latency.
Public propertySchema
The domains schema or schema source definition, if any.
Public propertySortPriority
The priority in which this domain should be listed amongst other domains. Domains with larger sortPrioriity values will appear earlier/higher in listings. Domains with the same/no priority will be sorted alphabetically.
Public propertyStatusDashboard
The domain's dashboard source definition, if any.
Public propertyStatusSummary
The domain's status source definition, if any.
Public propertySubDomains
The domain's subdomains or the source definition to use to load them.
Public propertyValidation
The domain's validation source definition, if any.
Top
Methods
  NameDescription
Public methodStatic memberClearDomainRegistrations
Clears the given domain namespace from domain registrations.
Public methodStatic memberRegisterDomain(Vault, String, ConfigurationDomain)
Registers an application domain in the vault. The domain's id will be used as the registration key.
Public methodStatic memberRegisterDomain(Vault, String, String, ConfigurationDomainOrSource)
Registers an application domain in the vault.
Public methodStatic memberRegisterDomain(Vault, String, String, SourceDefinition)
Registers an application domain in the vault.
Public methodStatic memberUnregisterDomain(Vault, String, ConfigurationDomain)
Unregisters an application domain from the vault assuming it has been registered with it's id.
Public methodStatic memberUnregisterDomain(Vault, String, String)
Unregisters an application domain from the vault assuming it has been registered with it's id.
Top
Fields
  NameDescription
Public fieldStatic memberStorageType
The named value storage type where vault application domains are registered.
Top
See Also