CTXMAMConfigManager

Last published : Oct 31, 2026
Superclass:
NSObject
Declared In:
CTXMAMConfigManager
This is the class is the main configuration class for your application. It contains methods for storing and retrieving custom configurations.
<tt>-getConfigurationAsBoolForKey:defaultValue:outError:</tt>
getConfigurationAsBoolForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (BOOL) type.
<tt>-getConfigurationAsDataForKey:defaultValue:outError:</tt>
getConfigurationAsDataForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSData *) type.
<tt>-getConfigurationAsDictionaryForKey:defaultValue:outError:</tt>
getConfigurationAsDictionaryForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSDictionary *) type.
<tt>-getConfigurationAsDoubleForKey:defaultValue:outError:</tt>
getConfigurationAsDoubleForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (double) type.
<tt>-getConfigurationAsIntegerForKey:defaultValue:outError:</tt>
getConfigurationAsIntegerForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSInteger) type.
<tt>-getConfigurationAsNumberForKey:defaultValue:outError:</tt>
getConfigurationAsNumberForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSNumber *) type.
<tt>-getConfigurationAsObjectForKey:defaultValue:outError:</tt>
getConfigurationAsObjectForKey function retrieves the data associated with the specified configuration name.
<tt>-getConfigurationAsStringForKey:defaultValue:outError:</tt>
getConfigurationAsStringForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSString *) type.
<tt>-getSharedConfigurationAsBoolForKey:defaultValue:outError:</tt>
getConfigurationAsBoolForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (BOOL) type.
<tt>-getSharedConfigurationAsDataForKey:defaultValue:outError:</tt>
getConfigurationAsDataForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSData *) type.
<tt>-getSharedConfigurationAsDictionaryForKey:defaultValue:outError:</tt>
getConfigurationAsDictionaryForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSDictionary *) type.
<tt>-getSharedConfigurationAsDoubleForKey:defaultValue:outError:</tt>
getConfigurationAsDoubleForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (double) type.
<tt>-getSharedConfigurationAsIntegerForKey:defaultValue:outError:</tt>
getConfigurationAsIntegerForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSInteger) type.
<tt>-getSharedConfigurationAsNumberForKey:defaultValue:outError:</tt>
getConfigurationAsNumberForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSNumber *) type.
<tt>-getSharedConfigurationAsObjectForKey:defaultValue:outError:</tt>
getConfigurationAsObjectForKey function retrieves the data associated with the specified configuration name.
<tt>-getSharedConfigurationAsStringForKey:defaultValue:outError:</tt>
getConfigurationAsStringForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSString *) type.
<tt>-NS_UNAVAILABLE</tt>
initializes the class, this function is not available for consumption please use sharedConfigManager in order to obtain an instance of this class.
<tt>-removeConfigurationForKey:outError:</tt>
removeConfigurationForKey function removes the data associated with the specified configuration name from the secure storage.
<tt>-removeSharedConfigurationForKey:outError:</tt>
removeConfigurationForKey function removes the data associated with the specified configuration name from the secure storage.
<tt>-setConfigurationForKey:boolValue:outError:</tt>
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name.
<tt>-setConfigurationForKey:dataValue:outError:</tt>
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name.
<tt>-setConfigurationForKey:dictValue:outError:</tt>
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name.
<tt>-setConfigurationForKey:doubleValue:outError:</tt>
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name.
<tt>-setConfigurationForKey:intValue:outError:</tt>
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name.
<tt>-setConfigurationForKey:numberValue:outError:</tt>
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name.
<tt>-setConfigurationForKey:objectValue:outError:</tt>
setConfigurationForKey function saves the data associated with the specified configuration name.
<tt>-setConfigurationForKey:stringValue:outError:</tt>
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name.
<tt>-setSharedConfigurationForKey:boolValue:outError:</tt>
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name.
<tt>-setSharedConfigurationForKey:dataValue:outError:</tt>
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name.
<tt>-setSharedConfigurationForKey:dictValue:outError:</tt>
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name.
<tt>-setSharedConfigurationForKey:doubleValue:outError:</tt>
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name.
<tt>-setSharedConfigurationForKey:intValue:outError:</tt>
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name.
<tt>-setSharedConfigurationForKey:numberValue:outError:</tt>
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name.
<tt>-setSharedConfigurationForKey:objectValue:outError:</tt>
setConfigurationForKey function saves the data associated with the specified configuration name.
<tt>-setSharedConfigurationForKey:stringValue:outError:</tt>
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name.
<tt>+sharedConfigManager</tt>
the singleton of the CTXMAMConfigManager class.
getConfigurationAsBoolForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (BOOL) type. 
-(BOOL) getConfigurationAsBoolForKey: (NSString *) config

        defaultValue: (BOOL) defaultValue outError: (NSError **) error; 
config
A string object which describes the saved data.
defaultValue
The value to be returned in case the specified configuration can not be found in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
The (BOOL) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned.
getConfigurationAsDataForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSData *) type. 
-(NSData *) getConfigurationAsDataForKey: (NSString *) config

        defaultValue: (NSData *) defaultValue outError: (NSError **) error; 
config
A string object which describes the saved data.
defaultValue
The value to be returned in case the specified configuration can not be found in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
The (NSData *) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned.
getConfigurationAsDictionaryForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSDictionary *) type. 
-(NSDictionary *) getConfigurationAsDictionaryForKey: (NSString *) config

        defaultValue: (NSDictionary *) defaultValue outError: (NSError **) error; 
config
A string object which describes the saved data.
defaultValue
The value to be returned in case the specified configuration can not be found in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
The (NSDictionary *) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned.
getConfigurationAsDoubleForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (double) type. 
-(double) getConfigurationAsDoubleForKey: (NSString *) config

        defaultValue: (double) defaultValue outError: (NSError **) error; 
config
A string object which describes the saved data.
defaultValue
The value to be returned in case the specified configuration can not be found in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
The (double) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned.
getConfigurationAsIntegerForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSInteger) type. 
-(NSInteger) getConfigurationAsIntegerForKey: (NSString *) config

        defaultValue: (NSInteger) defaultValue outError: (NSError **) error; 
config
A string object which describes the saved data.
defaultValue
The value to be returned in case the specified configuration can not be found in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
The (NSInteger) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned.
getConfigurationAsNumberForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSNumber *) type. 
-(NSNumber *) getConfigurationAsNumberForKey: (NSString *) config

        defaultValue: (NSNumber *) defaultValue outError: (NSError **) error; 
config
A string object which describes the saved data.
defaultValue
The value to be returned in case the specified configuration can not be found in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
The (NSNumber *) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned.
getConfigurationAsObjectForKey function retrieves the data associated with the specified configuration name. 
-(id) getConfigurationAsObjectForKey: (NSString *) config

        defaultValue: (id) defaultValue outError: (NSError **) error; 
config
A string object which describes the saved data.
defaultValue
The value to be returned in case the specified configuration can not be found in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
The id of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned.
getConfigurationAsStringForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSString *) type. 
-(NSString *) getConfigurationAsStringForKey: (NSString *) config

        defaultValue: (NSString *) defaultValue outError: (NSError **) error; 
config
A string object which describes the saved data.
defaultValue
The value to be returned in case the specified configuration can not be found in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
The (NSString *) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned.
getConfigurationAsBoolForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (BOOL) type. 
-(BOOL) getSharedConfigurationAsBoolForKey: (NSString *) config

        defaultValue: (BOOL) defaultValue outError: (NSError **) error; 
config
A string object which describes the saved data.
defaultValue
The value to be returned in case the specified configuration can not be found in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
The (BOOL) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned.
getConfigurationAsDataForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSData *) type. 
-(NSData *) getSharedConfigurationAsDataForKey: (NSString *) config

        defaultValue: (NSData *) defaultValue outError: (NSError **) error; 
config
A string object which describes the saved data.
defaultValue
The value to be returned in case the specified configuration can not be found in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
The (NSData *) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned.
getConfigurationAsDictionaryForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSDictionary *) type. 
-(NSDictionary *) getSharedConfigurationAsDictionaryForKey: (NSString *) config

        defaultValue: (NSDictionary *) defaultValue outError: (NSError **) error; 
config
A string object which describes the saved data.
defaultValue
The value to be returned in case the specified configuration can not be found in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
The (NSDictionary *) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned.
getConfigurationAsDoubleForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (double) type. 
-(double) getSharedConfigurationAsDoubleForKey: (NSString *) config

        defaultValue: (double) defaultValue outError: (NSError **) error; 
config
A string object which describes the saved data.
defaultValue
The value to be returned in case the specified configuration can not be found in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
The (double) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned.
getConfigurationAsIntegerForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSInteger) type. 
-(NSInteger) getSharedConfigurationAsIntegerForKey: (NSString *) config

        defaultValue: (NSInteger) defaultValue outError: (NSError **) error; 
config
A string object which describes the saved data.
defaultValue
The value to be returned in case the specified configuration can not be found in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
The (NSInteger) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned.
getConfigurationAsNumberForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSNumber *) type. 
-(NSNumber *) getSharedConfigurationAsNumberForKey: (NSString *) config

        defaultValue: (NSNumber *) defaultValue outError: (NSError **) error; 
config
A string object which describes the saved data.
defaultValue
The value to be returned in case the specified configuration can not be found in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
The (NSNumber *) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned.
getConfigurationAsObjectForKey function retrieves the data associated with the specified configuration name. 
-(id) getSharedConfigurationAsObjectForKey: (NSString *) config

        defaultValue: (id) defaultValue outError: (NSError **) error; 
config
A string object which describes the saved data.
defaultValue
The value to be returned in case the specified configuration can not be found in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
The id of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned.
getConfigurationAsStringForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSString *) type. 
-(NSString *) getSharedConfigurationAsStringForKey: (NSString *) config

        defaultValue: (NSString *) defaultValue outError: (NSError **) error; 
config
A string object which describes the saved data.
defaultValue
The value to be returned in case the specified configuration can not be found in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
The (NSString *) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned.
initializes the class, this function is not available for consumption please use sharedConfigManager in order to obtain an instance of this class. 
-(id) init NS_UNAVAILABLE; 
removeConfigurationForKey function removes the data associated with the specified configuration name from the secure storage. 
-(id) removeConfigurationForKey: (NSString *) config

        outError: (NSError **) error; 
config
A string object which describes the data to be removed.
error
An out parameter where an error will be saved in case one occurs.
YES if removing the data was successful, otherwise NO.
removeConfigurationForKey function removes the data associated with the specified configuration name from the secure storage. 
-(id) removeSharedConfigurationForKey: (NSString *) config

        outError: (NSError **) error; 
config
A string object which describes the data to be removed.
error
An out parameter where an error will be saved in case one occurs.
YES if removing the data was successful, otherwise NO.
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. 
-(BOOL) setConfigurationForKey: (NSString *) config

        boolValue: (BOOL) boolValue outError: (NSError **) error; 
config
A string object which describes the data being saved.
boolValue
The value to be saved in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
YES if saving the object was successful, otherwise NO.
If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed.
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. 
-(BOOL) setConfigurationForKey: (NSString *) config

        dataValue: (NSData *) dataValue outError: (NSError **) error; 
config
A string object which describes the data being saved.
dataValue
The value to be saved in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
YES if saving the object was successful, otherwise NO.
If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed.
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. 
-(BOOL) setConfigurationForKey: (NSString *) config

        dictValue: (NSDictionary *) dictValue outError: (NSError **) error; 
config
A string object which describes the data being saved.
dictValue
The value to be saved in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
YES if saving the object was successful, otherwise NO.
If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed.
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. 
-(BOOL) setConfigurationForKey: (NSString *) config

        doubleValue: (double) doubleValue outError: (NSError **) error; 
config
A string object which describes the data being saved.
doubleValue
The value to be saved in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
YES if saving the object was successful, otherwise NO.
If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed.
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. 
-(BOOL) setConfigurationForKey: (NSString *) config intValue: (NSInteger) intValue

        outError: (NSError **) error; 
config
A string object which describes the data being saved.
intValue
The value to be saved in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
YES if saving the object was successful, otherwise NO.
If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed.
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. 
-(BOOL) setConfigurationForKey: (NSString *) config

        numberValue: (NSNumber *) numberValue outError: (NSError **) error; 
config
A string object which describes the data being saved.
numberValue
The value to be saved in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
YES if saving the object was successful, otherwise NO.
If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed.
setConfigurationForKey function saves the data associated with the specified configuration name. 
-(BOOL) setConfigurationForKey: (NSString *) config

        objectValue: (id) objectValue outError: (NSError **) error; 
config
A string object which describes the data being saved.
objectValue
The value to be saved in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
YES if saving the object was successful, otherwise NO.
If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed.
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. 
-(BOOL) setConfigurationForKey: (NSString *) config

        stringValue: (NSString *) stringValue outError: (NSError **) error; 
config
A string object which describes the data being saved.
stringValue
The value to be saved in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
YES if saving the object was successful, otherwise NO.
If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed.
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. 
-(BOOL) setSharedConfigurationForKey: (NSString *) config

        boolValue: (BOOL) boolValue outError: (NSError **) error; 
config
A string object which describes the data being saved.
boolValue
The value to be saved in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
YES if saving the object was successful, otherwise NO.
If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed.
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. 
-(BOOL) setSharedConfigurationForKey: (NSString *) config

        dataValue: (NSData *) dataValue outError: (NSError **) error; 
config
A string object which describes the data being saved.
dataValue
The value to be saved in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
YES if saving the object was successful, otherwise NO.
If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed.
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. 
-(BOOL) setSharedConfigurationForKey: (NSString *) config

        dictValue: (NSDictionary *) dictValue outError: (NSError **) error; 
config
A string object which describes the data being saved.
dictValue
The value to be saved in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
YES if saving the object was successful, otherwise NO.
If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed.
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. 
-(BOOL) setSharedConfigurationForKey: (NSString *) config

        doubleValue: (double) doubleValue outError: (NSError **) error; 
config
A string object which describes the data being saved.
doubleValue
The value to be saved in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
YES if saving the object was successful, otherwise NO.
If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed.
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. 
-(BOOL) setSharedConfigurationForKey: (NSString *) config

        intValue: (NSInteger) intValue outError: (NSError **) error; 
config
A string object which describes the data being saved.
intValue
The value to be saved in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
YES if saving the object was successful, otherwise NO.
If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed.
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. 
-(BOOL) setSharedConfigurationForKey: (NSString *) config

        numberValue: (NSNumber *) numberValue outError: (NSError **) error; 
config
A string object which describes the data being saved.
numberValue
The value to be saved in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
YES if saving the object was successful, otherwise NO.
If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed.
setConfigurationForKey function saves the data associated with the specified configuration name. 
-(BOOL) setSharedConfigurationForKey: (NSString *) config

        objectValue: (id) objectValue outError: (NSError **) error; 
config
A string object which describes the data being saved.
objectValue
The value to be saved in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
YES if saving the object was successful, otherwise NO.
If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed.
setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. 
-(BOOL) setSharedConfigurationForKey: (NSString *) config

        stringValue: (NSString *) stringValue outError: (NSError **) error; 
config
A string object which describes the data being saved.
stringValue
The value to be saved in the secure storage.
error
An out parameter where an error will be saved in case one occurs.
YES if saving the object was successful, otherwise NO.
If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed.
the singleton of the CTXMAMConfigManager class. 
+(CTXMAMConfigManager *) sharedConfigManager; 
An instance of the CTXMAMConfigManager class.
 
Related information
CTXMAMConfigManager