Interface IDeviceConfigManager
Interface for device configuration manager.
Namespace: Phoenix.DeviceConfiguration
Assembly: Phoenix.Abstractions.DeviceConfiguration.dll
Syntax
public interface IDeviceConfigManager
Properties
View SourceConfigurations
Gets the configurations that have been loaded.
Declaration
IReadOnlyCollection<IDeviceConfiguration> Configurations { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IReadOnlyCollection<IDeviceConfiguration> |
IconUri
Gets the icon for the device config module.
Declaration
Uri IconUri { get; }
Property Value
Type | Description |
---|---|
System.Uri |
Methods
View SourceChangeDeviceEnlistment(IDevice, String)
Changes a devices enlistment to the specific configuration.
Declaration
void ChangeDeviceEnlistment(IDevice device, string configName)
Parameters
Type | Name | Description |
---|---|---|
IDevice | device | The device to enlist. |
System.String | configName | The configuration to enlist in. |
GetConfiguration(String)
Gets the specified configuration.
Declaration
IDeviceConfiguration GetConfiguration(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name of the configuration. |
Returns
Type | Description |
---|---|
IDeviceConfiguration | The IDeviceConfiguration. |
LoadConfigurationSettings(IDeviceConfiguration, Boolean)
Loads settings from a IDeviceConfiguration object.
Declaration
void LoadConfigurationSettings(IDeviceConfiguration config, bool overwrite)
Parameters
Type | Name | Description |
---|---|---|
IDeviceConfiguration | config | The IDeviceConfiguration object to load. |
System.Boolean | overwrite | Overwrite existing configurations or settings values if they already exist. |
LoadConfigurationSettings(String, Boolean)
Loads one or more configurations from a settings file.
Declaration
IReadOnlyCollection<IDeviceConfiguration> LoadConfigurationSettings(string configurationFile, bool overwrite)
Parameters
Type | Name | Description |
---|---|---|
System.String | configurationFile | The path to a configuration settings file. |
System.Boolean | overwrite | Overwrite existing configurations or settings values if they already exist. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IReadOnlyCollection<IDeviceConfiguration> | The configurations loaded. |
SaveConfigurationsToFile(String, IEnumerable<IDeviceConfiguration>)
Saves one or more configurations to a settings file.
Declaration
void SaveConfigurationsToFile(string configurationFile, IEnumerable<IDeviceConfiguration> configurations)
Parameters
Type | Name | Description |
---|---|---|
System.String | configurationFile | The path to save the configuration settings file. |
System.Collections.Generic.IEnumerable<IDeviceConfiguration> | configurations | The configurations to save. |