CBLRevision.h

Go to the documentation of this file.

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

#import "CBLBase.h"
@class CBLDocument, CBLDatabase, CBLAttachment, CBLSavedRevision, CBLUnsavedRevision;

NS_ASSUME_NONNULL_BEGIN

@interface CBLRevision : NSObject

@property (readonly, weak) CBLDocument* document;

@property (readonly) CBLDatabase* database;

@property (readonly) BOOL isDeletion;

@property (readonly) BOOL isGone;

@property (readonly, nullable) NSString* revisionID;

@property (readonly, nullable) CBLSavedRevision* parentRevision;

@property (readonly, nullable) NSString* parentRevisionID;

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

@property (readonly, nullable) CBLJSONDict* properties;

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

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

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

#pragma mark ATTACHMENTS

@property (readonly, nullable) CBLArrayOf(NSString*)* attachmentNames;

- (nullable CBLAttachment*) attachmentNamed: (NSString*)name;

@property (readonly, nullable) CBLArrayOf(CBLAttachment*)* attachments;

- (instancetype) init NS_UNAVAILABLE;

@end



@interface CBLSavedRevision : CBLRevision

@property (readonly) BOOL propertiesAvailable;

- (CBLUnsavedRevision*) createRevision;

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

- (nullable CBLSavedRevision*) deleteDocument: (NSError**)outError;

@end



@interface CBLUnsavedRevision : CBLRevision

// These properties are overridden to be settable:
@property (readwrite) BOOL isDeletion;
@property (readwrite, copy, nullable) NSMutableDictionary* properties;
@property (readwrite, copy, nullable) CBLJSONDict* userProperties;
- (void) setObject: (nullable id)object forKeyedSubscript: (NSString*)key;

- (nullable CBLSavedRevision*) save: (NSError**)outError;

- (nullable CBLSavedRevision*) saveAllowingConflict: (NSError**)outError;

- (void) setAttachmentNamed: (NSString*)name
            withContentType: (nullable NSString*)mimeType
                    content: (nullable NSData*)content;

- (void) setAttachmentNamed: (NSString*)name
            withContentType: (nullable NSString*)mimeType
                 contentURL: (nullable NSURL*)fileURL;

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

@end


NS_ASSUME_NONNULL_END