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"
 
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_REFCOUNTED(CBLDocument*, Document);



_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_Timestamp(const CBLDocument*) CBLAPI;

uint64_t CBLDocument_Sequence(const CBLDocument*) CBLAPI;

CBLCollection* _cbl_nullable CBLDocument_Collection(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;


 
CBL_CAPI_END