Parameters for adding a revision using c4doc_put. More...

#include <c4DocumentTypes.h>

Data Fields
C4String	body
	Revision's body.

C4String	docID
	Document ID.

C4RevisionFlags	revFlags
	Revision flags (deletion, attachments, keepBody)

bool	existingRevision
	Is this an already-existing rev coming from replication?

bool	allowConflict
	OK to create a conflict, i.e. can parent be non-leaf?

const C4String *	history
	Array of ancestor revision IDs.

size_t	historyCount
	Size of history[] array.

bool	save
	Save the document after inserting the revision?

uint32_t	maxRevTreeDepth
	Max depth of revision tree to save (or 0 for default)

C4RemoteID	remoteDBID
	Identifier of remote db this rev's from (or 0 if local)

C4SliceResult	allocedBody
	Set this instead of body if body is heap-allocated.

C4DocDeltaApplier	deltaCB
	If non-NULL, will be called to generate the actual body.

void *	deltaCBContext
	Passed to `deltaCB` callback.

C4String	deltaSourceRevID
	Source rev for delta (must be valid if deltaCB is given)

Detailed Description

Parameters for adding a revision using c4doc_put.

Field Documentation

◆ allocedBody

C4SliceResult C4DocPutRequest::allocedBody

Set this instead of body if body is heap-allocated.

◆ allowConflict

bool C4DocPutRequest::allowConflict

OK to create a conflict, i.e. can parent be non-leaf?

◆ body

C4String C4DocPutRequest::body

Revision's body.

◆ deltaCB

C4DocDeltaApplier C4DocPutRequest::deltaCB

If non-NULL, will be called to generate the actual body.

◆ deltaCBContext

void* C4DocPutRequest::deltaCBContext

Passed to deltaCB callback.

◆ deltaSourceRevID

C4String C4DocPutRequest::deltaSourceRevID

Source rev for delta (must be valid if deltaCB is given)

◆ docID

C4String C4DocPutRequest::docID

Document ID.

◆ existingRevision

bool C4DocPutRequest::existingRevision

Is this an already-existing rev coming from replication?

◆ history

const C4String* C4DocPutRequest::history

Array of ancestor revision IDs.

◆ historyCount

size_t C4DocPutRequest::historyCount

Size of history[] array.

◆ maxRevTreeDepth

uint32_t C4DocPutRequest::maxRevTreeDepth

Max depth of revision tree to save (or 0 for default)

◆ remoteDBID

C4RemoteID C4DocPutRequest::remoteDBID

Identifier of remote db this rev's from (or 0 if local)

◆ revFlags

C4RevisionFlags C4DocPutRequest::revFlags

Revision flags (deletion, attachments, keepBody)

◆ save

bool C4DocPutRequest::save

Save the document after inserting the revision?

The documentation for this struct was generated from the following file:

c4DocumentTypes.h

Data Fields