CBLDocument.h

Go to the documentation of this file.

//
// CBLDocument.h
//
// Copyright (c) 2018 Couchbase, Inc All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
 
#pragma once
#include "CBLBase.h"
#include "fleece/Fleece.h"
 
CBL_CAPI_BEGIN
 
CBL_PUBLIC extern const FLSlice kCBLTypeProperty;             
 
typedef CBL_ENUM(uint8_t, CBLConcurrencyControl) {
    kCBLConcurrencyControlLastWriteWins,
    kCBLConcurrencyControlFailOnConflict
};
 
 
typedef bool (*CBLConflictHandler)(void* _cbl_nullable context,
                                   CBLDocument* _cbl_nullable documentBeingSaved,
                                   const CBLDocument* _cbl_nullable conflictingDocument);
 
 
_cbl_warn_unused
const CBLDocument* _cbl_nullable CBLDatabase_GetDocument(const CBLDatabase* database,
                                                         FLString docID,
                                                         CBLError* _cbl_nullable outError) CBLAPI;
 
CBL_REFCOUNTED(CBLDocument*, Document);
 
bool CBLDatabase_SaveDocument(CBLDatabase* db,
                              CBLDocument* doc,
                              CBLError* _cbl_nullable outError) CBLAPI;
 
bool CBLDatabase_SaveDocumentWithConcurrencyControl(CBLDatabase* db,
                                                    CBLDocument* doc,
                                                    CBLConcurrencyControl concurrency,
                                                    CBLError* _cbl_nullable outError) CBLAPI;
 
bool CBLDatabase_SaveDocumentWithConflictHandler(CBLDatabase* db,
                                                 CBLDocument* doc,
                                                 CBLConflictHandler conflictHandler,
                                                 void* _cbl_nullable context,
                                                 CBLError* _cbl_nullable outError) CBLAPI;
 
bool CBLDatabase_DeleteDocument(CBLDatabase *db,
                                const CBLDocument* document,
                                CBLError* _cbl_nullable outError) CBLAPI;
 
bool CBLDatabase_DeleteDocumentWithConcurrencyControl(CBLDatabase *db,
                                                      const CBLDocument* document,
                                                      CBLConcurrencyControl concurrency,
                                                      CBLError* _cbl_nullable outError) CBLAPI;
 
bool CBLDatabase_PurgeDocument(CBLDatabase* db,
                               const CBLDocument* document,
                               CBLError* _cbl_nullable outError) CBLAPI;
 
bool CBLDatabase_PurgeDocumentByID(CBLDatabase* database,
                                   FLString docID,
                                   CBLError* _cbl_nullable outError) CBLAPI;
 
_cbl_warn_unused
CBLDocument* _cbl_nullable CBLDatabase_GetMutableDocument(CBLDatabase* database,
                                                          FLString docID,
                                                          CBLError* _cbl_nullable outError) CBLAPI;
 
_cbl_warn_unused
CBLDocument* CBLDocument_Create(void) CBLAPI;
 
_cbl_warn_unused
CBLDocument* CBLDocument_CreateWithID(FLString docID) CBLAPI;
 
_cbl_warn_unused
CBLDocument* CBLDocument_MutableCopy(const CBLDocument* original) CBLAPI;
 
FLString CBLDocument_ID(const CBLDocument*) CBLAPI;
 
FLString CBLDocument_RevisionID(const CBLDocument*) CBLAPI;
 
uint64_t CBLDocument_Sequence(const CBLDocument*) CBLAPI;
 
FLDict CBLDocument_Properties(const CBLDocument*) CBLAPI;
 
FLMutableDict CBLDocument_MutableProperties(CBLDocument*) CBLAPI;
 
void CBLDocument_SetProperties(CBLDocument*,
                               FLMutableDict properties) CBLAPI;
 
_cbl_warn_unused
FLSliceResult CBLDocument_CreateJSON(const CBLDocument*) CBLAPI;
 
bool CBLDocument_SetJSON(CBLDocument*,
                         FLSlice json,
                         CBLError* _cbl_nullable outError) CBLAPI;
 
CBLTimestamp CBLDatabase_GetDocumentExpiration(CBLDatabase* db,
                                               FLSlice docID,
                                               CBLError* _cbl_nullable outError) CBLAPI;
 
bool CBLDatabase_SetDocumentExpiration(CBLDatabase* db,
                                       FLSlice docID,
                                       CBLTimestamp expiration,
                                       CBLError* _cbl_nullable outError) CBLAPI;
 
typedef void (*CBLDocumentChangeListener)(void *context,
                                          const CBLDatabase* db,
                                          FLString docID);
 
_cbl_warn_unused
CBLListenerToken* CBLDatabase_AddDocumentChangeListener(const CBLDatabase* db,
                                                        FLString docID,
                                                        CBLDocumentChangeListener listener,
                                                        void* _cbl_nullable context) CBLAPI;
 
CBL_CAPI_END