c8ofullsynccbl.md

c8osdkjscore › C8oFullSyncCbl

Class: C8oFullSyncCbl

Hierarchy

• C8oFullSync

  ↳ C8oFullSyncCbl

Index

Constructors

• constructor

Properties

• c8o
• canceled
• cblChangeListeners
• fullSyncChangeListeners
• fullSyncDatabaseUrlBase
• fullSyncDatabases
• localSuffix
• replicationsToRestart
• ATTACHMENT_PROPERTY_KEY_CONTENT_URL
• FULL_SYNC_PROJECT
• FULL_SYNC__ATTACHMENTS
• FULL_SYNC__ID
• FULL_SYNC__REV

Methods

• addFullSyncChangeListener
• checkState
• getDocucmentFromDatabase
• getOrCreateFullSyncDatabase
• getResponseFromLocalCache
• handleAllDocumentsRequest
• handleAllLocalDocumentsRequest
• handleBulkRequest
• handleCreateDatabaseRequest
• handleCreateIndexRequest
• handleDeleteAttachmentRequest
• handleDeleteDocumentRequest
• handleDeleteIndexRequest
• handleDestroyDatabaseRequest
• handleExplainRequest
• handleFullSyncRequest
• handleFullSyncResponse
• handleGetAttachmentRequest
• handleGetAttachmentUrlRequest
• handleGetDocumentRequest
• handleGetFindRequest
• handleGetIndexesRequest
• handleGetViewRequest
• handleInfoRequest
• handlePostDocumentRequest
• handlePutAttachmentRequest
• handleReplicatePullRequest
• handleReplicatePushRequest
• handleResetDatabaseRequest
• handleSearchRequest
• handleSyncRequest
• overrideDocument
• removeFullSyncChangeListener
• saveResponseToLocalCache
• applySubPolicyDelete
• applySubPolicyForMerge
• applySubPolicyOverride
• deepCloneObject
• isFullSyncRequest
• mergeArrayProperties
• mergeProperties

Constructors

constructor

+ new C8oFullSyncCbl(c8o: C8oCore): C8oFullSyncCbl

Overrides C8oFullSync.constructor

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:132

Parameters:

Name	Type
c8o	C8oCore

Returns: C8oFullSyncCbl

Properties

c8o

• c8o: C8oCore

Inherited from C8oFullSync.c8o

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:28

---

canceled

• canceled: boolean = false

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:132

---

Private cblChangeListeners

• cblChangeListeners: any[] = []

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:130

---

Private fullSyncChangeListeners

• fullSyncChangeListeners: C8oFullSyncChangeListener[][] = []

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:129

---

Protected fullSyncDatabaseUrlBase

• fullSyncDatabaseUrlBase: string

Inherited from C8oFullSync.fullSyncDatabaseUrlBase

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:29

---

Private fullSyncDatabases

• fullSyncDatabases: Object

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:128

---

Protected localSuffix

• localSuffix: string

Inherited from C8oFullSync.localSuffix

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:30

---

replicationsToRestart

• replicationsToRestart: Array‹ReplicationState› = []

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:131

---

Static Private ATTACHMENT_PROPERTY_KEY_CONTENT_URL

▪ ATTACHMENT_PROPERTY_KEY_CONTENT_URL: string = "content_url"

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:127

---

Static FULL_SYNC_PROJECT

▪ FULL_SYNC_PROJECT: string = "fs://"

Inherited from C8oFullSync.FULL_SYNC_PROJECT

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:23

The project requestable value to execute a fullSync request.

---

Static FULL_SYNC__ATTACHMENTS

▪ FULL_SYNC__ATTACHMENTS: string = "_attachments"

Inherited from C8oFullSync.FULL_SYNC__ATTACHMENTS

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:26

---

Static FULL_SYNC__ID

▪ FULL_SYNC__ID: string = "_id"

Inherited from C8oFullSync.FULL_SYNC__ID

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:24

---

Static FULL_SYNC__REV

▪ FULL_SYNC__REV: string = "_rev"

Inherited from C8oFullSync.FULL_SYNC__REV

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:25

Methods

addFullSyncChangeListener

▸ addFullSyncChangeListener(db: string, listener: C8oFullSyncChangeListener, parameters: Object): Promise‹void›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:910

Parameters:

Name	Type	Default
db	string	-
listener	C8oFullSyncChangeListener	-
parameters	Object	{}

Returns: Promise‹void›

---

Private checkState

▸ checkState(): boolean

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:517

Check network status before starting a replication

Returns: boolean

---

getDocucmentFromDatabase

▸ getDocucmentFromDatabase(c8o: C8oCore, databaseName: string, documentId: string): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:791

Parameters:

Name	Type
c8o	C8oCore
databaseName	string
documentId	string

Returns: Promise‹any›

---

getOrCreateFullSyncDatabase

▸ getOrCreateFullSyncDatabase(databaseName: string, isLocalCache: boolean): Promise‹C8oFullSyncDatabase›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:150

Returns the database with this name in the list.
If it does not already exist yet then creates it and adds it to the list.

throws C8oException Failed to create a new fullSync database.

Parameters:

Name	Type	Default
databaseName	string	-
isLocalCache	boolean	false

Returns: Promise‹C8oFullSyncDatabase›

C8oFullSyncDatabase

---

getResponseFromLocalCache

▸ getResponseFromLocalCache(c8oCallRequestIdentifier: string): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:821

Parameters:

Name	Type
c8oCallRequestIdentifier	string

Returns: Promise‹any›

---

handleAllDocumentsRequest

▸ handleAllDocumentsRequest(databaseName: string, parameters: Object): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:358

Parameters:

Name	Type
databaseName	string
parameters	Object

Returns: Promise‹any›

---

handleAllLocalDocumentsRequest

▸ handleAllLocalDocumentsRequest(databaseName: string, parameters: Object): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:373

Parameters:

Name	Type
databaseName	string
parameters	Object

Returns: Promise‹any›

---

handleBulkRequest

▸ handleBulkRequest(databaseName: string, parameters: Object): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:585

Parameters:

Name	Type
databaseName	string
parameters	Object

Returns: Promise‹any›

---

handleCreateDatabaseRequest

▸ handleCreateDatabaseRequest(databaseName: string): Promise‹FullSyncDefaultResponse›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:580

Parameters:

Name	Type
databaseName	string

Returns: Promise‹FullSyncDefaultResponse›

---

handleCreateIndexRequest

▸ handleCreateIndexRequest(databaseName: string, fields: any, parameters: Object): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:447

Parameters:

Name	Type
databaseName	string
fields	any
parameters	Object

Returns: Promise‹any›

---

handleDeleteAttachmentRequest

▸ handleDeleteAttachmentRequest(databaseName: string, docid: string, attachmentName: string): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:335

Parameters:

Name	Type
databaseName	string
docid	string
attachmentName	string

Returns: Promise‹any›

---

handleDeleteDocumentRequest

▸ handleDeleteDocumentRequest(DatabaseName: string, docid: string, parameters: Object): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:215

Parameters:

Name	Type
DatabaseName	string
docid	string
parameters	Object

Returns: Promise‹any›

---

handleDeleteIndexRequest

▸ handleDeleteIndexRequest(databaseName: string, parameters: Object): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:490

Parameters:

Name	Type
databaseName	string
parameters	Object

Returns: Promise‹any›

---

handleDestroyDatabaseRequest

▸ handleDestroyDatabaseRequest(databaseName: string): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:633

Parameters:

Name	Type
databaseName	string

Returns: Promise‹any›

---

handleExplainRequest

▸ handleExplainRequest(databaseName: string, selector: any, parameters: Object): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:469

Parameters:

Name	Type
databaseName	string
selector	any
parameters	Object

Returns: Promise‹any›

---

handleFullSyncRequest

▸ handleFullSyncRequest(_parameters: Object, listener: C8oResponseListener): Promise‹any›

Inherited from C8oFullSync.handleFullSyncRequest

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:47

Handles a fullSync request.
It determines the type of the request thanks to parameters.

throws C8oException

Parameters:

Name	Type
_parameters	Object
listener	C8oResponseListener

Returns: Promise‹any›

promise

---

handleFullSyncResponse

▸ handleFullSyncResponse(response: any, listener: C8oResponseListener): any

Overrides C8oFullSync.handleFullSyncResponse

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:165

Parameters:

Name	Type
response	any
listener	C8oResponseListener

Returns: any

---

handleGetAttachmentRequest

▸ handleGetAttachmentRequest(databaseName: string, docid: string, attachmentName: string, parameters: any): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:321

Parameters:

Name	Type
databaseName	string
docid	string
attachmentName	string
parameters	any

Returns: Promise‹any›

---

handleGetAttachmentUrlRequest

▸ handleGetAttachmentUrlRequest(fullSyncDatabaseName: string, docid: string, parameters: Object): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:180

Parameters:

Name	Type
fullSyncDatabaseName	string
docid	string
parameters	Object

Returns: Promise‹any›

---

handleGetDocumentRequest

▸ handleGetDocumentRequest(fullSyncDatabaseName: string, docid: string, parameters: Object): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:191

Parameters:

Name	Type
fullSyncDatabaseName	string
docid	string
parameters	Object

Returns: Promise‹any›

---

handleGetFindRequest

▸ handleGetFindRequest(databaseName: string, selector: any, parameters: Object): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:458

Parameters:

Name	Type
databaseName	string
selector	any
parameters	Object

Returns: Promise‹any›

---

handleGetIndexesRequest

▸ handleGetIndexesRequest(databaseName: string, parameters: Object): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:480

Parameters:

Name	Type
databaseName	string
parameters	Object

Returns: Promise‹any›

---

handleGetViewRequest

▸ handleGetViewRequest(databaseName: string, ddocName: string, viewName: string, parameters: Object): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:404

Parameters:

Name	Type
databaseName	string
ddocName	string
viewName	string
parameters	Object

Returns: Promise‹any›

---

handleInfoRequest

▸ handleInfoRequest(databaseName: string): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:620

Parameters:

Name	Type
databaseName	string

Returns: Promise‹any›

---

handlePostDocumentRequest

▸ handlePostDocumentRequest(databaseName: string, fullSyncPolicy: FullSyncPolicy, parameters: Object, fullsyncPolicySubMerge: any): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:248

Parameters:

Name	Type	Default
databaseName	string	-
fullSyncPolicy	FullSyncPolicy	-
parameters	Object	-
fullsyncPolicySubMerge	any	null

Returns: Promise‹any›

---

handlePutAttachmentRequest

▸ handlePutAttachmentRequest(databaseName: string, docid: string, attachmentName: string, attachmentType: string, attachmentContent: any): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:296

Parameters:

Name	Type
databaseName	string
docid	string
attachmentName	string
attachmentType	string
attachmentContent	any

Returns: Promise‹any›

---

handleReplicatePullRequest

▸ handleReplicatePullRequest(databaseName: string, parameters: Object, c8oResponseListener: C8oResponseListener): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:534

Parameters:

Name	Type
databaseName	string
parameters	Object
c8oResponseListener	C8oResponseListener

Returns: Promise‹any›

---

handleReplicatePushRequest

▸ handleReplicatePushRequest(databaseName: string, parameters: Object, c8oResponseListener: C8oResponseListener): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:547

Parameters:

Name	Type
databaseName	string
parameters	Object
c8oResponseListener	C8oResponseListener

Returns: Promise‹any›

---

handleResetDatabaseRequest

▸ handleResetDatabaseRequest(databaseName: string): Promise‹FullSyncDefaultResponse›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:560

Parameters:

Name	Type
databaseName	string

Returns: Promise‹FullSyncDefaultResponse›

---

handleSearchRequest

▸ handleSearchRequest(databaseName: string, query: any, fields: any, parameters: Object): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:500

Parameters:

Name	Type
databaseName	string
query	any
fields	any
parameters	Object

Returns: Promise‹any›

---

handleSyncRequest

▸ handleSyncRequest(databaseName: string, parameters: Object, c8oResponseListener: C8oResponseListener): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:521

Parameters:

Name	Type
databaseName	string
parameters	Object
c8oResponseListener	C8oResponseListener

Returns: Promise‹any›

---

overrideDocument

▸ overrideDocument(document: any, properties: Object, databaseName: any): Promise‹void›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:805

Parameters:

Name	Type
document	any
properties	Object
databaseName	any

Returns: Promise‹void›

---

removeFullSyncChangeListener

▸ removeFullSyncChangeListener(db: string, listener: C8oFullSyncChangeListener): Promise‹void›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:957

Parameters:

Name	Type
db	string
listener	C8oFullSyncChangeListener

Returns: Promise‹void›

---

saveResponseToLocalCache

▸ saveResponseToLocalCache(c8oCallRequestIdentifier: string, localCacheResponse: C8oLocalCacheResponse): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:873

Parameters:

Name	Type
c8oCallRequestIdentifier	string
localCacheResponse	C8oLocalCacheResponse

Returns: Promise‹any›

---

Static applySubPolicyDelete

▸ applySubPolicyDelete(objToChange: any, path: any, index: any, subPolicy: any): void

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:672

Recursive function that browse object to be modified and apply delete

Parameters:

Name	Type	Description
objToChange	any	Object: the object to be modified
path	any	string: The path where to find object to be modified
index	any	number: index
subPolicy	any	Object: subPolicy to be applied

Returns: void

---

Static applySubPolicyForMerge

▸ applySubPolicyForMerge(override: any, source: any, objToChange: any, subPolicy: any): void

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:727

Global function that will apply sub policy for merge

Parameters:

Name	Type	Description
override	any	boolean: if we have to perform override sub policy or not
source	any	Object: the object posted
objToChange	any	Object: the object to be modified
subPolicy	any	Object: subPolicy to be applied

Returns: void

---

Static applySubPolicyOverride

▸ applySubPolicyOverride(objToChange: any, path: any, index: any, source: any, subPolicy: any): void

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:694

Recursive function that browse object to be modified and apply override

Parameters:

Name	Type	Description
objToChange	any	Object: the object to be modified
path	any	string: The path where to find object to be modified
index	any	number: index
source	any	Object: the object posted
subPolicy	any	Object: subPolicy to be applied

Returns: void

---

Static deepCloneObject

▸ deepCloneObject(obj: any): any

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:653

Allow to clone object whithout reference

Parameters:

Name	Type	Description
obj	any	Object: object to be cloned

Returns: any

---

Static isFullSyncRequest

▸ isFullSyncRequest(requestParameter: Object): boolean

Inherited from C8oFullSync.isFullSyncRequest

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:115

Checks if request parameters correspond to a fullSync request.

Parameters:

Name	Type
requestParameter	Object

Returns: boolean

---

Static mergeArrayProperties

▸ mergeArrayProperties(newArray: any, oldArray: any): void

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:764

Parameters:

Name	Type
newArray	any
oldArray	any

Returns: void

---

Static mergeProperties

▸ mergeProperties(newProperties: Object, oldProperties: Object, useMergePolicy: string): void

Defined in c8osdk-js-core/src/c8o/c8oFullSync.ts:742

Parameters:

Name	Type	Default
newProperties	Object	-
oldProperties	Object	-
useMergePolicy	string	"none"

Returns: void