CTXMAMConfigManager

Superclass NSObject Declared In CTXMAMConfigManager Introduction This is the class is the main configuration class for your application. It contains methods for storing and retrieving custom configurations. Methods -getConfigurationAsBoolForKey:defaultValue:outError getConfigurationAsBoolForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (BOOL) type. -getConfigurationAsDataForKey:defaultValue:outError getConfigurationAsDataForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSData *) type. -getConfigurationAsDictionaryForKey:defaultValue:outError getConfigurationAsDictionaryForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSDictionary *) type. -getConfigurationAsDoubleForKey:defaultValue:outError getConfigurationAsDoubleForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (double) type. -getConfigurationAsIntegerForKey:defaultValue:outError getConfigurationAsIntegerForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSInteger) type. -getConfigurationAsNumberForKey:defaultValue:outError getConfigurationAsNumberForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSNumber *) type. -getConfigurationAsObjectForKey:defaultValue:outError getConfigurationAsObjectForKey function retrieves the data associated with the specified configuration name. -getConfigurationAsStringForKey:defaultValue:outError getConfigurationAsStringForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSString *) type. -getSharedConfigurationAsBoolForKey:defaultValue:outError getConfigurationAsBoolForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (BOOL) type. -getSharedConfigurationAsDataForKey:defaultValue:outError getConfigurationAsDataForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSData *) type. -getSharedConfigurationAsDictionaryForKey:defaultValue:outError getConfigurationAsDictionaryForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSDictionary *) type. -getSharedConfigurationAsDoubleForKey:defaultValue:outError getConfigurationAsDoubleForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (double) type. -getSharedConfigurationAsIntegerForKey:defaultValue:outError getConfigurationAsIntegerForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSInteger) type. -getSharedConfigurationAsNumberForKey:defaultValue:outError getConfigurationAsNumberForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSNumber *) type. -getSharedConfigurationAsObjectForKey:defaultValue:outError getConfigurationAsObjectForKey function retrieves the data associated with the specified configuration name. -getSharedConfigurationAsStringForKey:defaultValue:outError getConfigurationAsStringForKey is a convenience function which retrieves the data associated with the specified configuration name and returns as a (NSString *) type. -NS_UNAVAILABLE initializes the class, this function is not available for consumption please use sharedConfigManager in order to obtain an instance of this class. -removeConfigurationForKey:outError removeConfigurationForKey function removes the data associated with the specified configuration name from the secure storage. -removeSharedConfigurationForKey:outError removeConfigurationForKey function removes the data associated with the specified configuration name from the secure storage. -setConfigurationForKey:boolValue:outError setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. -setConfigurationForKey:dataValue:outError setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. -setConfigurationForKey:dictValue:outError setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. -setConfigurationForKey:doubleValue:outError setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. -setConfigurationForKey:intValue:outError setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. -setConfigurationForKey:numberValue:outError setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. -setConfigurationForKey:objectValue:outError setConfigurationForKey function saves the data associated with the specified configuration name. -setConfigurationForKey:stringValue:outError setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. -setSharedConfigurationForKey:boolValue:outError setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. -setSharedConfigurationForKey:dataValue:outError setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. -setSharedConfigurationForKey:dictValue:outError setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. -setSharedConfigurationForKey:doubleValue:outError setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. -setSharedConfigurationForKey:intValue:outError setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. -setSharedConfigurationForKey:numberValue:outError setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. -setSharedConfigurationForKey:objectValue:outError setConfigurationForKey function saves the data associated with the specified configuration name. -setSharedConfigurationForKey:stringValue:outError setConfigurationForKey is a convenience function which saves the data associated with the specified configuration name. +sharedConfigManager the singleton of the CTXMAMConfigManager class. getConfigurationAsBoolForKey:defaultValue:outError 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; Parameters 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. Return Value The (BOOL) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned. getConfigurationAsDataForKey:defaultValue:outError 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; Parameters 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. Return Value The (NSData *) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned. getConfigurationAsDictionaryForKey:defaultValue:outError 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; Parameters 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. Return Value The (NSDictionary *) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned. getConfigurationAsDoubleForKey:defaultValue:outError 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; Parameters 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. Return Value The (double) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned. getConfigurationAsIntegerForKey:defaultValue:outError 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; Parameters 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. Return Value The (NSInteger) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned. getConfigurationAsNumberForKey:defaultValue:outError 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; Parameters 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. Return Value The (NSNumber *) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned. getConfigurationAsObjectForKey:defaultValue:outError getConfigurationAsObjectForKey function retrieves the data associated with the specified configuration name. -(id) getConfigurationAsObjectForKey: (NSString *) config defaultValue: (id) defaultValue outError: (NSError **) error; Parameters 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. Return Value The id of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned. getConfigurationAsStringForKey:defaultValue:outError 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; Parameters 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. Return Value The (NSString *) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned. getSharedConfigurationAsBoolForKey:defaultValue:outError 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; Parameters 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. Return Value The (BOOL) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned. getSharedConfigurationAsDataForKey:defaultValue:outError 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; Parameters 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. Return Value The (NSData *) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned. getSharedConfigurationAsDictionaryForKey:defaultValue:outError 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; Parameters 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. Return Value The (NSDictionary *) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned. getSharedConfigurationAsDoubleForKey:defaultValue:outError 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; Parameters 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. Return Value The (double) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned. getSharedConfigurationAsIntegerForKey:defaultValue:outError 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; Parameters 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. Return Value The (NSInteger) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned. getSharedConfigurationAsNumberForKey:defaultValue:outError 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; Parameters 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. Return Value The (NSNumber *) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned. getSharedConfigurationAsObjectForKey:defaultValue:outError getConfigurationAsObjectForKey function retrieves the data associated with the specified configuration name. -(id) getSharedConfigurationAsObjectForKey: (NSString *) config defaultValue: (id) defaultValue outError: (NSError **) error; Parameters 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. Return Value The id of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned. getSharedConfigurationAsStringForKey:defaultValue:outError 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; Parameters 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. Return Value The (NSString *) representation of the object found in the secure storage if found, otherwise the value passed to the defaultValue parameter is returned. NS_UNAVAILABLE 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:outError removeConfigurationForKey function removes the data associated with the specified configuration name from the secure storage. -(id) removeConfigurationForKey: (NSString *) config outError: (NSError **) error; Parameters 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. Return Value YES if removing the data was successful, otherwise NO. removeSharedConfigurationForKey:outError removeConfigurationForKey function removes the data associated with the specified configuration name from the secure storage. -(id) removeSharedConfigurationForKey: (NSString *) config outError: (NSError **) error; Parameters 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. Return Value YES if removing the data was successful, otherwise NO. setConfigurationForKey:boolValue:outError 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; Parameters 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. Return Value YES if saving the object was successful, otherwise NO. Discussion 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:dataValue:outError 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; Parameters 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. Return Value YES if saving the object was successful, otherwise NO. Discussion 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:dictValue:outError 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; Parameters 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. Return Value YES if saving the object was successful, otherwise NO. Discussion 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:doubleValue:outError 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; Parameters 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. Return Value YES if saving the object was successful, otherwise NO. Discussion 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:intValue:outError 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; Parameters 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. Return Value YES if saving the object was successful, otherwise NO. Discussion 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:numberValue:outError 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; Parameters 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. Return Value YES if saving the object was successful, otherwise NO. Discussion 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:objectValue:outError setConfigurationForKey function saves the data associated with the specified configuration name. -(BOOL) setConfigurationForKey: (NSString *) config objectValue: (id) objectValue outError: (NSError **) error; Parameters 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. Return Value YES if saving the object was successful, otherwise NO. Discussion 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:stringValue:outError 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; Parameters 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. Return Value YES if saving the object was successful, otherwise NO. Discussion If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed. setSharedConfigurationForKey:boolValue:outError 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; Parameters 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. Return Value YES if saving the object was successful, otherwise NO. Discussion If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed. setSharedConfigurationForKey:dataValue:outError 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; Parameters 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. Return Value YES if saving the object was successful, otherwise NO. Discussion If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed. setSharedConfigurationForKey:dictValue:outError 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; Parameters 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. Return Value YES if saving the object was successful, otherwise NO. Discussion If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed. setSharedConfigurationForKey:doubleValue:outError 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; Parameters 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. Return Value YES if saving the object was successful, otherwise NO. Discussion If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed. setSharedConfigurationForKey:intValue:outError 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; Parameters 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. Return Value YES if saving the object was successful, otherwise NO. Discussion If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed. setSharedConfigurationForKey:numberValue:outError 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; Parameters 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. Return Value YES if saving the object was successful, otherwise NO. Discussion If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed. setSharedConfigurationForKey:objectValue:outError setConfigurationForKey function saves the data associated with the specified configuration name. -(BOOL) setSharedConfigurationForKey: (NSString *) config objectValue: (id) objectValue outError: (NSError **) error; Parameters 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. Return Value YES if saving the object was successful, otherwise NO. Discussion If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed. setSharedConfigurationForKey:stringValue:outError 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; Parameters 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. Return Value YES if saving the object was successful, otherwise NO. Discussion If a configuration name which already exists in the secure storage is passed then the stored value is overwritten by the new value passed. sharedConfigManager the singleton of the CTXMAMConfigManager class. +(CTXMAMConfigManager *) sharedConfigManager; Return Value An instance of the CTXMAMConfigManager class.  
CTXMAMConfigManager