CBLTimeSeries.h

Go to the documentation of this file.

//
//  CBLTimeSeries.h
//  CouchbaseLite
//
//  Created by Jens Alfke on 10/26/15.
//  Copyright © 2015 Couchbase, Inc. All rights reserved.
//

#import "CBLBase.h"
@class CBLDatabase, CBLReplication;


NS_ASSUME_NONNULL_BEGIN

@interface CBLTimeSeries : NSObject

- (nullable instancetype) initWithDatabase: (CBLDatabase*)db
                                   docType: (NSString*)docType
                                     error: (NSError**)error;

@property (readonly) NSString* docType;

@property (copy) NSString* docIDPrefix;

@property (readonly, nullable) NSError* lastError;

- (void) addEvent: (CBLJSONDict*)event;

- (void) addEvent: (CBLJSONDict*)event atTime: (CFAbsoluteTime)time;

- (void) flushAsync: (void(^)(BOOL))onFlushed;

- (BOOL) flush;

- (void) stop;



- (CBLReplication*) createPushReplication: (NSURL*)remoteURL
                          purgeWhenPushed: (BOOL)purgeWhenPushed;



- (NSEnumerator<CBLJSONDict*>*) eventsFromDate: (nullable NSDate*)startDate
                                        toDate: (nullable NSDate*)endDate
                                         error: (NSError**)outError;

typedef void (^CBLTimeSeriesEnumerationBlock)(CBLJSONDict* event, CFAbsoluteTime time, BOOL *stop);

+ (BOOL) enumerateEventsInDocument: (CBLJSONDict*)doc
                        usingBlock: (CBLTimeSeriesEnumerationBlock)block;

@end

NS_ASSUME_NONNULL_END