CBLArray

@protocol CBLArray <NSObject, CBLArrayFragment, NSFastEnumeration>

CBLArray protocol defines a set of methods for reading array data.

  • Gets a number of the items in the array.

    Declaration

    Objective-C

    @property (readonly, atomic) NSUInteger count;

    Swift

    var count: UInt { get }

  • Undocumented

    Declaration

    Objective-C

    - (nullable id) valueAtIndex: (NSUInteger)index;

    Swift

    func value(at index: UInt) -> Any?

  • Gets value at the given index as a string. Returns nil if the value doesn’t exist, or its value is not a string.

    Declaration

    Objective-C

    - (nullable NSString *)stringAtIndex:(NSUInteger)index;

    Swift

    func string(at index: UInt) -> String?

    Parameters

    index

    The index.

    Return Value

    The NSString object or nil.

  • Gets value at the given index as a number. Returns nil if the value doesn’t exist, or its value is not a number.

    Declaration

    Objective-C

    - (nullable NSNumber *)numberAtIndex:(NSUInteger)index;

    Swift

    func number(at index: UInt) -> NSNumber?

    Parameters

    index

    The index.

    Return Value

    The NSNumber object or nil.

  • Gets value at the given index as an integer value. Floating point values will be rounded. The value true is returned as 1, false as 0. Returns 0 if the value doesn’t exist or does not have a numeric value.

    Declaration

    Objective-C

    - (NSInteger)integerAtIndex:(NSUInteger)index;

    Swift

    func integer(at index: UInt) -> Int

    Parameters

    index

    The index.

    Return Value

    The integer value.

  • Gets value at the given index as a long long value. Floating point values will be rounded. The value true is returned as 1, false as 0. Returns 0 if the value doesn’t exist or does not have a numeric value.

    Declaration

    Objective-C

    - (long long)longLongAtIndex:(NSUInteger)index;

    Swift

    func longLong(at index: UInt) -> Int64

    Parameters

    index

    The index.

    Return Value

    The long long value.

  • Gets value at the given index as a float value. Integers will be converted to float. The value true is returned as 1.0, false as 0.0. Returns 0.0 if the value doesn’t exist or does not have a numeric value.

    Declaration

    Objective-C

    - (float)floatAtIndex:(NSUInteger)index;

    Swift

    func float(at index: UInt) -> Float

    Parameters

    index

    The index.

    Return Value

    The float value.

  • Gets value at the given index as a double value. Integers will be converted to double. The value true is returned as 1.0, false as 0.0. Returns 0.0 if the property doesn’t exist or does not have a numeric value.

    Declaration

    Objective-C

    - (double)doubleAtIndex:(NSUInteger)index;

    Swift

    func double(at index: UInt) -> Double

    Parameters

    index

    The index.

    Return Value

    The double value.

  • Gets value at the given index as a boolean. Returns YES if the value exists, and is either true or a nonzero number.

    Declaration

    Objective-C

    - (BOOL)booleanAtIndex:(NSUInteger)index;

    Swift

    func boolean(at index: UInt) -> Bool

    Parameters

    index

    The index.

    Return Value

    The boolean value.

  • Gets value at the given index as an NSDate. JSON does not directly support dates, so the actual property value must be a string, which is then parsed according to the ISO-8601 date format (the default used in JSON.) Returns nil if the value doesn’t exist, is not a string, or is not parseable as a date. NOTE: This is not a generic date parser! It only recognizes the ISO-8601 format, with or without milliseconds.

    Declaration

    Objective-C

    - (nullable NSDate *)dateAtIndex:(NSUInteger)index;

    Swift

    func date(at index: UInt) -> Date?

    Parameters

    index

    The index.

    Return Value

    The NSDate object or nil.

  • Get value at the given index as a CBLBlob. Returns nil if the value doesn’t exist, or its value is not a CBLBlob.

    Declaration

    Objective-C

    - (nullable CBLBlob *)blobAtIndex:(NSUInteger)index;

    Swift

    func blob(at index: UInt) -> CBLBlob?

    Parameters

    index

    The index.

    Return Value

    The CBLBlob object or nil.

  • Gets value as a CBLArray, which is a mapping object of an array value. Returns nil if the value doesn’t exists, or its value is not an array.

    Declaration

    Objective-C

    - (nullable CBLArray *)arrayAtIndex:(NSUInteger)index;

    Swift

    func atIndex(_ index: UInt) -> CBLArray?

    Parameters

    index

    The index.

    Return Value

    The CBLArray object or nil.

  • Get value at the given index as a CBLDictionary, which is a mapping object of a dictionary value. Returns nil if the value doesn’t exists, or its value is not a dictionary.

    Declaration

    Objective-C

    - (nullable CBLDictionary *)dictionaryAtIndex:(NSUInteger)index;

    Swift

    func dictionary(at index: UInt) -> CBLDictionary?

    Parameters

    index

    The index.

    Return Value

    The CBLDictionary object or nil.

Data

  • Gets content of the current object as an NSArray. The value types of the values contained in the returned NSArray object are CBLBlob, NSArray, NSDictionary, NSNumber, NSNull, and NSString.

    Declaration

    Objective-C

    - (nonnull NSArray *)toArray;

    Swift

    func toArray() -> [Any]

    Return Value

    The NSArray object representing the content of the current object.