SettingsLoader Class Reference

#import <SettingsLoader.h>

Inheritance diagram for SettingsLoader:

Instance Methods
(BOOL)	- loadSettingsFromFileAtPath:withError:
(BOOL)	- loadSettingsFromString:withError:

Detailed Description

SettingsLoader class provides the means to load your settings to prepare your module for its specific action.

Note

Do not initialize this class directly, it will crash at runtime. Use the specific module loader subclass instead.

Method Documentation

loadSettingsFromFileAtPath:withError:()

- (BOOL) loadSettingsFromFileAtPath:		(NSString *_Nonnull)	settingsFilePath
withError:		(NSError *_Nullable *_Nullable)	error

Loads settings from the given file path

Remarks

Relevant errors: SENSITIVITYIO_ESETTINGS, ENOENT, EIO

Parameters

settingsFilePath	The path of the settings file to load
error	The error representing the reason for the load failure

Returns

True if settings loading was successful, false in case an error occured

loadSettingsFromString:withError:()

- (BOOL) loadSettingsFromString:		(NSString *_Nonnull)	settingsString
withError:		(NSError *_Nullable *_Nullable)	error

Loads settings from the given string

Remarks

Relevant errors: SENSITIVITYIO_ESETTINGS

Parameters

settingsString	The settings string to load
error	The error representing the reason for the load failure

Returns

True if settings loading was successful, false in case an error occured

---

The documentation for this class was generated from the following file:

• SettingsLoader.h