CBLDocument.h

Go to the documentation of this file.

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

#import "CBLDatabase.h"
@class CBLSavedRevision, CBLUnsavedRevision, CBLDatabaseChange;
@protocol CBLDocumentModel;

NS_ASSUME_NONNULL_BEGIN

@interface CBLDocument : NSObject

@property (readonly) CBLDatabase* database;

@property (readonly) NSString* documentID;

@property (readonly) NSString* abbreviatedID;

@property (readonly) BOOL isDeleted;

@property (readonly) BOOL isGone;

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

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

@property (strong, nullable) NSDate* expirationDate;


#pragma mark REVISIONS:

@property (readonly, copy, nullable) NSString* currentRevisionID;

@property (readonly, nullable) CBLSavedRevision* currentRevision;

- (nullable CBLSavedRevision*) revisionWithID: (NSString*)revisionID;

- (nullable CBLArrayOf(CBLSavedRevision*)*) getRevisionHistory: (NSError**)outError;

- (nullable CBLArrayOf(CBLSavedRevision*)*) getConflictingRevisions: (NSError**)outError;

- (nullable CBLArrayOf(CBLSavedRevision*)*) getLeafRevisions: (NSError**)outError;

- (CBLUnsavedRevision*) newRevision;


#pragma mark PROPERTIES:

@property (readonly, copy, nullable) CBLJSONDict* properties;

@property (readonly, copy, nullable) CBLJSONDict* userProperties;

- (nullable id) propertyForKey: (NSString*)key;

- (nullable id)objectForKeyedSubscript:(NSString*)key;

- (nullable CBLSavedRevision*) putProperties: (CBLJSONDict*)properties
                                       error: (NSError**)outError;

- (nullable CBLSavedRevision*) update: (BOOL(^)(CBLUnsavedRevision*))block
                                error: (NSError**)outError;

- (BOOL) putExistingRevisionWithProperties: (CBLJSONDict*)properties
                               attachments: (nullable NSDictionary*)attachments
                           revisionHistory: (CBLArrayOf(NSString*)*)revIDs
                                   fromURL: (nullable NSURL*)sourceURL
                                     error: (NSError**)outError;

#pragma mark MODEL:

@property (weak, nullable) id<CBLDocumentModel> modelObject;


- (instancetype) init NS_UNAVAILABLE;

@end



@protocol CBLDocumentModel <NSObject>
- (void) document: (CBLDocument*)doc
        didChange: (CBLDatabaseChange*)change;
@end



extern NSString* const kCBLDocumentChangeNotification;


NS_ASSUME_NONNULL_END