c8ofullsync.md

c8osdkjscore › C8oFullSync

Class: C8oFullSync

Hierarchy

• C8oFullSync

  ↳ C8oFullSyncCbl

Index

Constructors

• constructor

Properties

• c8o
• fullSyncDatabaseUrlBase
• localSuffix
• FULL_SYNC_PROJECT
• FULL_SYNC_URL_PATH
• FULL_SYNC__ATTACHMENTS
• FULL_SYNC__ID
• FULL_SYNC__REV

Methods

• handleFullSyncRequest
• handleFullSyncResponse
• isFullSyncRequest

Constructors

constructor

+ new C8oFullSync(c8o: C8oCore): C8oFullSync

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

Parameters:

Name	Type
c8o	C8oCore

Returns: C8oFullSync

Properties

c8o

• c8o: C8oCore

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

---

Protected fullSyncDatabaseUrlBase

• fullSyncDatabaseUrlBase: string

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

---

Protected localSuffix

• localSuffix: string

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

---

Static FULL_SYNC_PROJECT

▪ FULL_SYNC_PROJECT: string = "fs://"

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

The project requestable value to execute a fullSync request.

---

Static Private FULL_SYNC_URL_PATH

▪ FULL_SYNC_URL_PATH: string = "/fullsync/"

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

---

Static FULL_SYNC__ATTACHMENTS

▪ FULL_SYNC__ATTACHMENTS: string = "_attachments"

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

---

Static FULL_SYNC__ID

▪ FULL_SYNC__ID: string = "_id"

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

---

Static FULL_SYNC__REV

▪ FULL_SYNC__REV: string = "_rev"

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

Methods

handleFullSyncRequest

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

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

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

throws C8oException Failed to parse response.

Parameters:

Name	Type
response	any
listener	C8oResponseListener

Returns: any

response

---

Static isFullSyncRequest

▸ isFullSyncRequest(requestParameter: Object): boolean

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