CBLMutableDictionary

@protocol CBLMutableDictionary <CBLDictionary>

CBLMutableDictionary protocol defines a set of methods for writing dictionary data.

Type Setters

  • 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;

    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;

    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;

    Parameters

    value

    The NSNumber object.

  • Set an integer value for the given key.

    Declaration

    Objective-C

    - (void)setInteger:(NSInteger)value forKey:(nonnull NSString *)key;

    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;

    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;

    Parameters

    value

    The float value.

  • Set a double value for the given key.

    Declaration

    Objective-C

    - (void)setDouble:(double)value forKey:(nonnull NSString *)key;

    Parameters

    value

    The double value.

  • Set a boolean value for the given key.

    Declaration

    Objective-C

    - (void)setBoolean:(BOOL)value forKey:(nonnull NSString *)key;

    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;

    Parameters

    value

    The Date object.

  • Set a CBLBlob object for the given key. A nil value will be converted to an NSNull.

    Declaration

    Objective-C

    - (void)setBlob:(nullable CBLBlob *)value forKey:(nonnull NSString *)key;

    Parameters

    value

    The CBLBolb object.

  • Set a CBLArray object for the given key. A nil value will be converted to an NSNull.

    Declaration

    Objective-C

    - (void)setArray:(nullable CBLArray *)value forKey:(nonnull NSString *)key;

    Parameters

    value

    The CBLArray 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;

    Parameters

    value

    The CBLDictionary object.

Removing Entries

  • Removes a given key and its value from the dictionary.

    Declaration

    Objective-C

    - (void)removeValueForKey:(nonnull NSString *)key;

    Parameters

    key

    The key.

Data

  • 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:(nonnull NSDictionary<NSString *, id> *)data;

    Parameters

    data

    The data.

  • Set data with JSON string.

    Declaration

    Objective-C

    - (BOOL)setJSON:(nonnull NSString *)json
          error:(NSError *_Nullable *_Nullable)error;

    Parameters

    json

    The JSON string with data.
    error

    On return, the error if any.

    Return Value

    True on success, false on failure.

Getting dictionary and array object

  • 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;

    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;

    Parameters

    key

    The key.

    Return Value

    The CBLMutableDictionary object or nil if the key doesn’t exist.

Subscript

  • Subscripting access to a CBLMutableFragment object that represents the value of the dictionary by key.

    Declaration

    Objective-C

    - (nullable CBLMutableFragment *)objectForKeyedSubscript:
    (nonnull NSString *)key;

    Parameters

    key

    The key.

    Return Value

    The CBLMutableFragment object.