M-Files Vault Application Framework
Configuration
Methods
| GetCapabilities |
Describes the capabilities this node has.
The capabilities returned correspond to which
interface methods are implemented/ok to call.
(Overrides DashboardNodeGetCapabilities) |
| GetCommands |
Provides the commands that can be shown and/or run for this node.
Only safe to call if GetCapabilities returns the
Commands flag.
(Inherited from ConfigurationDomainNode) |
| GetConfiguration |
Gets the current/stored configuration value for the node.
Only safe to call if GetCapabilities returns the
Configuration flag.
(Overrides ConfigurationDomainNodeGetConfiguration(IConfigurationRequestContext)) |
| GetConfigurationSchema |
Gets the schema describing the structure of the configuration.
Only safe to call if GetCapabilities returns the
Schema flag.
(Overrides ConfigurationDomainNodeGetConfigurationSchema(IConfigurationRequestContext)) |
| GetDashboardContent |
Provides the html for a custom dashboard to display for the node.
Only safe to call if GetCapabilities returns the
StatusDashboard flag.
(Inherited from DashboardNode) |
| GetDescription |
Provides a description of the domain.
Currently displayed in the domain header area, and in some
default dashboards.
(Inherited from ConfigurationDomainNode) |
| GetID |
Provides the static id for the node.
This value should at least be unique amongst siblings.
IDs cannot have spaces, newlines or periods.
(Inherited from DashboardNode) |
| GetName |
Gets the human readable name for the domain.
Can be localized.
(Inherited from DashboardNode) |
| GetSortPriority |
Controls the order in which the node appears amongst siblings.
(Inherited from ConfigurationDomainNode) |
| GetStatusSummary |
Provides a status summary for the node.
Only safe to call if GetCapabilities returns the
StatusSummary flag.
(Inherited from ConfigurationDomainNode) |
| GetSubDomainNodes |
Provides a list of sub domain nodes to appear as children of this node.
Only safe to call if GetCapabilities returns the
SubDomains flag.
(Inherited from DashboardNode) |
| RunDefaultValidation | Validates a configuration. |
| SaveConfiguration |
Saves a new configuration value for the node.
Only safe to call if GetCapabilities returns the
Configuration flag.
(Overrides ConfigurationDomainNodeSaveConfiguration(IConfigurationRequestContext, String, ClientOperations)) |
| Validate |
Validates the node along with the current, or passed configuration text.
Only safe to call if GetCapabilities returns the
Validation flag.
(Overrides ConfigurationDomainNodeValidate(IConfigurationRequestContext, String)) |