CBLDocument.h

Go to the documentation of this file.

//
//  CBLDocument.h
//  CouchbaseLite
//
//  Created by Pasin Suriyentrakorn on 12/29/16.
//  Copyright © 2016 Couchbase. All rights reserved.
//

#import <Foundation/Foundation.h>
#import "CBLProperties.h"
@class CBLDatabase;
@protocol CBLConflictResolver;

NS_ASSUME_NONNULL_BEGIN

extern NSString* const kCBLDocumentChangeNotification;

extern NSString* const kCBLDocumentSavedNotification;

extern NSString* const kCBLDocumentIsExternalUserInfoKey;


@interface CBLDocument : CBLProperties

- (instancetype) init NS_UNAVAILABLE;

@property (readonly, nonatomic) NSString* documentID;

@property (readonly, nonatomic) CBLDatabase* database;

@property (readonly, nonatomic) BOOL isDeleted;

@property (readonly, nonatomic) BOOL exists;

@property (readonly, nonatomic) uint64_t sequence;

@property (nonatomic, nullable) id<CBLConflictResolver> conflictResolver;

- (BOOL) save: (NSError**)error;

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

- (BOOL) purge: (NSError**)error;

- (void) revert;

@end


@interface CBLDocument (Subscripts)

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

- (void) setObject: (nullable id)value forKeyedSubscript: (NSString*)key;

@end

NS_ASSUME_NONNULL_END

// TODO:
// 1. Modellable