CBLMutableDictionary
@protocol CBLMutableDictionary <CBLDictionary, CBLMutableDictionaryFragment>
CBLMutableDictionary protocol defines a set of methods for writing dictionary data.
-
Set a value for the given key. Allowed value types are CBLMutableArray, CBLBlob, CBLMutableDictionary, NSArray, NSDate, NSDictionary, NSNumber, NSNull, NSString. The NSArrays and NSDictionaries must contain only the above types. An NSDate value will be converted to an ISO-8601 format string. A nil value will be converted an NSNull.
Declaration
Objective-C
- (void)setValue:(nullable id)value forKey:(nonnull NSString *)key;
Swift
func setValue(_ value: Any?, forKey key: String)
Parameters
value
The value.
key
The key.
-
Set an String object for the given key. A nil value will be converted to an NSNull.
Declaration
Objective-C
- (void)setString:(nullable NSString *)value forKey:(nonnull NSString *)key;
Swift
func setString(_ value: String?, forKey key: String)
Parameters
value
The String object.
-
Set an NSNumber object for the given key. A nil value will be converted to an NSNull.
Declaration
Objective-C
- (void)setNumber:(nullable NSNumber *)value forKey:(nonnull NSString *)key;
Swift
func setNumber(_ value: NSNumber?, forKey key: String)
Parameters
value
The NSNumber object.
-
Set an integer value for the given key.
Declaration
Objective-C
- (void)setInteger:(NSInteger)value forKey:(nonnull NSString *)key;
Swift
func setInteger(_ value: Int, forKey key: String)
Parameters
value
The integer value.
-
Set a long long value for the given key.
Declaration
Objective-C
- (void)setLongLong:(long long)value forKey:(nonnull NSString *)key;
Swift
func setLongLong(_ value: Int64, forKey key: String)
Parameters
value
The long long value.
-
Set a float value for the given key.
Declaration
Objective-C
- (void)setFloat:(float)value forKey:(nonnull NSString *)key;
Swift
func setFloat(_ value: Float, forKey key: String)
Parameters
value
The float value.
-
Set a double value for the given key.
Declaration
Objective-C
- (void)setDouble:(double)value forKey:(nonnull NSString *)key;
Swift
func setDouble(_ value: Double, forKey key: String)
Parameters
value
The double value.
-
Set a boolean value for the given key.
Declaration
Objective-C
- (void)setBoolean:(BOOL)value forKey:(nonnull NSString *)key;
Swift
func setBoolean(_ value: Bool, forKey key: String)
Parameters
value
The boolean value.
-
Set a Date object for the given key. A nil value will be converted to an NSNull.
Declaration
Objective-C
- (void)setDate:(nullable NSDate *)value forKey:(nonnull NSString *)key;
Swift
func setDate(_ value: Date?, forKey key: String)
Parameters
value
The Date object.
-
Set a CBLDictionary object for the given key. A nil value will be converted to an NSNull.
Declaration
Objective-C
- (void)setDictionary:(nullable CBLDictionary *)value forKey:(nonnull NSString *)key;
Swift
func setDictionary(_ value: CBLDictionary?, forKey key: String)
Parameters
value
The CBLDictionary object.
-
Removes a given key and its value from the dictionary.
Declaration
Objective-C
- (void)removeValueForKey:(nonnull NSString *)key;
Swift
func removeValue(forKey key: String)
Parameters
key
The key.
-
Set data for the dictionary. Allowed value types are CBLArray, CBLBlob, CBLDictionary, NSArray, NSDate, NSDictionary, NSNumber, NSNull, and NSString. The NSArrays and NSDictionaries must contain only the above types.
Declaration
Objective-C
- (void)setData:(nullable NSDictionary<NSString *, id> *)data;
Swift
func setData(_ data: [String : Any]?)
Parameters
data
The data.
-
Get a property’s value as a CBLMutableArray, which is a mapping object of an array value. Returns nil if the property doesn’t exists, or its value is not an array.
Declaration
Objective-C
- (nullable CBLMutableArray *)arrayForKey:(nonnull NSString *)key;
Swift
func array(forKey key: String) -> CBLMutableArray?
Parameters
key
The key.
Return Value
The CBLMutableArray object or nil if the property doesn’t exist.
-
Get a property’s value as a CBLMutableDictionary, which is a mapping object of a dictionary value. Returns nil if the property doesn’t exists, or its value is not a dictionary.
Declaration
Objective-C
- (nullable CBLMutableDictionary *)dictionaryForKey:(nonnull NSString *)key;
Swift
func forKey(_ key: String) -> CBLMutableDictionary?
Parameters
key
The key.
Return Value
The CBLMutableDictionary object or nil if the key doesn’t exist.
-
Subscripting access to a CBLMutableFragment object that represents the value of the dictionary by key.
Declaration
Objective-C
- (nullable CBLMutableFragment *)objectForKeyedSubscript: (nonnull NSString *)key;
Swift
subscript(key: String) -> CBLMutableFragment? { get }
Parameters
key
The key.
Return Value
The CBLMutableFragment object.