API Reference
Class
IntelligenceXConfig
Loads and holds the IntelligenceX configuration from disk.
Inheritance
- Object
- IntelligenceXConfig
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method IntelligenceXConfig.Load
Accepted by parameters
- Method IntelligenceXConfig.TryLoad
Constructors
public IntelligenceXConfig() #Methods
public static IntelligenceXConfig Load(String path = null, String baseDirectory = null) #Returns:
IntelligenceXConfigLoads configuration or throws if it cannot be found or parsed.
Parameters
- path System.String = null
- Optional explicit config path.
- baseDirectory System.String = null
- Optional base directory for resolving the default config path.
Returns
The loaded configuration.
Exceptions
FileNotFoundException– Thrown when the configuration file cannot be found.InvalidDataException– Thrown when the configuration file contains invalid JSON.
public static Boolean TryLoad(out IntelligenceXConfig config, String path = null, String baseDirectory = null) #Returns:
BooleanAttempts to load configuration from the provided path, the environment, or the default location.
Parameters
- config IntelligenceX.Configuration.IntelligenceXConfig@
- The populated configuration on success.
- path System.String = null
- Optional explicit config path.
- baseDirectory System.String = null
- Optional base directory for resolving the default config path.
Returns
true when the configuration was loaded; otherwise false.