CBLReplication.h

Go to the documentation of this file.

//
//  CBLReplication.h
//  CouchbaseLite
//
//  Created by Jens Alfke on 6/22/12.
//  Copyright (c) 2012-2013 Couchbase, Inc. All rights reserved.
//

#import "CBLBase.h"
@class CBLDatabase, CBLDocument;
@protocol CBLAuthenticator;

NS_ASSUME_NONNULL_BEGIN

typedef NS_ENUM(unsigned, CBLReplicationStatus) {
    kCBLReplicationStopped, 
    kCBLReplicationOffline, 
    kCBLReplicationIdle,    
    kCBLReplicationActive   
} ;


typedef void (^CBLAttachmentProgressBlock)(uint64_t bytesRead,
                                           uint64_t contentLength,
                                           NSError* error);


@interface CBLReplication : NSObject

@property (nonatomic, readonly) CBLDatabase* localDatabase;

@property (nonatomic, readonly) NSURL* remoteURL;

@property (nonatomic, readonly) BOOL pull;


#pragma mark - OPTIONS:

@property (nonatomic) BOOL createTarget;

@property (nonatomic) bool continuous;

@property (nonatomic, copy, nullable) NSString* filter;

@property (nonatomic, copy, nullable) CBLJSONDict* filterParams;

@property (nonatomic, copy, nullable) CBLArrayOf(NSString*)* channels;

@property (copy, nullable) CBLArrayOf(NSString*) *documentIDs;

@property (nonatomic) BOOL downloadsAttachments;

@property (nonatomic, copy, nullable) CBLDictOf(NSString*, NSString*)* headers;

@property (nonatomic, copy, nullable) NSString* network;

@property (nonatomic, copy, nullable) CBLJSONDict* customProperties;


#pragma mark - AUTHENTICATION:

@property (nonatomic, strong, nullable) id<CBLAuthenticator> authenticator;

@property (nonatomic, strong, nullable) NSURLCredential* credential;

@property (nonatomic, readonly) NSString* username;

@property (nonatomic, copy, nullable) CBLJSONDict* OAuth;

@property (readonly, nullable) NSURL* personaOrigin;

- (void) setCookieNamed: (NSString*)name
              withValue: (NSString*)value
                   path: (nullable NSString*)path
         expirationDate: (nullable NSDate*)expirationDate
                 secure: (BOOL)secure;

- (void) deleteCookieNamed: (NSString *)name;

- (BOOL) clearAuthenticationStores: (NSError**)outError;

+ (void) setAnchorCerts: (nullable NSArray*)certs onlyThese: (BOOL)onlyThese;

@property (readonly, nullable) SecCertificateRef serverCertificate;

#pragma mark - STATUS:

- (void) start;

- (void) stop;

- (void) restart;

@property BOOL suspended;

@property (nonatomic, readonly) CBLReplicationStatus status;

@property (nonatomic, readonly) BOOL running;

@property (nonatomic, readonly, strong, nullable) NSError* lastError;

@property (nonatomic, readonly) unsigned completedChangesCount;

@property (nonatomic, readonly) unsigned changesCount;

#pragma mark - PENDING DOCUMENTS (PUSH ONLY):

@property (readonly, nullable) NSSet* pendingDocumentIDs;

- (BOOL) isDocumentPending: (CBLDocument*)doc;

#pragma mark - ATTACHMENT DOWNLOADING (PULL ONLY)

- (NSProgress*) downloadAttachment: (CBLAttachment*)attachment;


- (instancetype) init NS_UNAVAILABLE;

@end


extern NSString* const kCBLReplicationChangeNotification;

extern NSString* const kCBLProgressErrorKey;


NS_ASSUME_NONNULL_END