Class ecm.model.SyncServer

Extends ecm.model._ModelObject.
Represents the sync server in IBM Content Navigator. It holds all related sync server information and functionality.
Defined in: <ecm\model\SyncServer.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.model.SyncServer()

Field Summary

Field Attributes	Field Name and Description
	enabled Boolean indicating if the sync server is enabled
	syncConfig Sync configuration settings.

Fields borrowed from class ecm.model._ModelObject:: categorization, id, isRecurring, name, nameFilter, pane, status, type, userId

Method Summary

Method Attributes	Method Name and Description
	canSyncItem(item) Determines if it's possible to sync the given item.
	checkClientCompatibility(callback, params) Checks sync client compatibility with the server.
	disableSyncForFavorites(favorites, callback) Disable sync for an array of ecm.model.Favorite objects.
	disableSyncForItems(items, callback) Disables sync for an array of ecm.model.Item or ecm.model.Teamspace objects.
	enableSyncForFavorites(favorites, callback) Enables sync for an array of ecm.model.Favorite objects.
	enableSyncForItems(items, callback) Enables sync for an array of ecm.model.Item or ecm.model.Teamspace objects.
	getChangesList(repository, params, callback) Retrieves a list of changes from the sync server.
	getSyncedFavorites(callback) Returns only the favorites that are being synced.
	initialize(response) Initially initializes the task manager with values from the desktop.
	onCheckClientCompatibilityComplete(item) Event method fired when register object completes.
	onDisableSyncForFavoritesComplete(favorites) Event method fired when disableSyncForFavorites favorites completes.
	onDisableSyncForItemsComplete(syncItems) Event method fired when disableSyncForItems items completes.
	onEnableSyncForFavoritesComplete(favorites) Event method fired when enableSyncForFavorites favorites completes.
	onEnableSyncForItemsComplete(syncItems) Event method fired when enableSyncForItems items completes.
	onGetChangeListComplete(resultSet) Event method called when getChangeList completes
	onRegisterObjectComplete(item) Event method fired when register object completes.
	onRegisterSyncItemsForDeviceComplete(syncItems) Event method fired when register sync items for device completes.
	onUnregisterObjectComplete() Event method fired when unregister object completes.
	onUnregisterSyncItemsForDeviceComplete(syncItems) Event method fired when unregister sync items for device completes.
	registerObject(registrationId, item, callback, params) Registers an object with the sync server.
	registerSyncItemsForDevice(syncItems, deviceId, callback, params) Registers an array of ecm.model.SyncItem objects for a device.
	unregisterObject(registrationId, item, callback, params) Unregisters an object with the sync server.
	unregisterSyncItemsForDevice(syncItems, deviceId, callback, params) Unregisters an array of ecm.model.SyncItem objects for a device.

Methods borrowed from class ecm.model._ModelObject:: destroy, onChange, own, refresh, toString

Constructor Detail

ecm.model.SyncServer()

Since:: 2.0.3

Field Detail

enabled

Boolean indicating if the sync server is enabled

syncConfig

Sync configuration settings.

Method Detail

canSyncItem(item)

Determines if it's possible to sync the given item. An item is either an instance of ecm.model.Favorite or ecm.model.Item.

Parameters:
item

Returns:: Returns true if the item can be synced and false if it cannot.

checkClientCompatibility(callback, params)

Checks sync client compatibility with the server.

Parameters:
callback: Callback function triggered when this method completes.
params: Object containing parameters to pass to the ecm.model.Request object.

disableSyncForFavorites(favorites, callback)

Disable sync for an array of ecm.model.Favorite objects.

Parameters:
favorites: An array of ecm.model.Favorite objects.
callback: Callback function triggered when the server call completes.

Deprecated:: As of 2.0.3.5. Sync Favorite will be removed in a future release.

disableSyncForItems(items, callback)

Disables sync for an array of ecm.model.Item or ecm.model.Teamspace objects.

Parameters:
items: An array of ecm.model.Item or ecm.model.Teamspace objects.
callback: Callback function triggered when the server call completes.

Since:: 2.0.3.5

enableSyncForFavorites(favorites, callback)

Enables sync for an array of ecm.model.Favorite objects.

Parameters:
favorites: The array of ecm.model.Favorite objects.
callback: Callback function triggered when the enableSyncForFavorites call completes.

Deprecated:: As of 2.0.3.5. Sync Favorite will be removed in a future release.

enableSyncForItems(items, callback)

Enables sync for an array of ecm.model.Item or ecm.model.Teamspace objects.

Parameters:
items: The array of ecm.model.Item or ecm.model.Teamspace objects.
callback: Callback function triggered when the enableSyncForItems call completes.

Since:: 2.0.3.5

getChangesList(repository, params, callback)

Retrieves a list of changes from the sync server.

Parameters:

repository

The ecm.model.Repository object to check for changes.

params

An object containing parameters to pass to the ecm.model.Request object. The params object must contain "requestParams". This is an object containing at least the following parameters:

pageSize - The number of results to retrieve. The default page size is 50.
changesSince - Required: Timestamp indicating the start time for the change list query.
changesUntil - Required: Timestamp indicating the stop time for the change list query.
marker - The current result number. The default will be 0.
registrationIds - Required: An array of device registration Ids.
lastUpdateTS - Required: Last update timestamp.

callback

Callback function triggered when this method completes.

getSyncedFavorites(callback)

Returns only the favorites that are being synced.

Parameters:
callback: Callback function called after favorites have been retrieved.

Returns:: An array of ecm.model.Favorite objects.

initialize(response)

Initially initializes the task manager with values from the desktop.

Parameters:
response

onCheckClientCompatibilityComplete(item)

Event method fired when register object completes.

Parameters:
item

onDisableSyncForFavoritesComplete(favorites)

Event method fired when disableSyncForFavorites favorites completes.

Parameters:
favorites: An array of ecm.model.Favorite objects.

Deprecated:: As of 2.0.3.5. Sync Favorite will be removed in a future release.

onDisableSyncForItemsComplete(syncItems)

Event method fired when disableSyncForItems items completes.

Parameters:
syncItems: An array of ecm.model.SyncItem objects.

Since:: 2.0.3.5

onEnableSyncForFavoritesComplete(favorites)

Event method fired when enableSyncForFavorites favorites completes.

Parameters:
favorites: An array of ecm.model.Favorite objects.

Deprecated:: As of 2.0.3.5. Sync Favorite will be removed in a future release.

onEnableSyncForItemsComplete(syncItems)

Event method fired when enableSyncForItems items completes.

Parameters:
syncItems: An array of ecm.model.SyncItem objects.

Since:: 2.0.3.5

onGetChangeListComplete(resultSet)

Event method called when getChangeList completes

Parameters:
resultSet: An instance of ecm.model.ResultSet

onRegisterObjectComplete(item)

Event method fired when register object completes.

Parameters:
item

onRegisterSyncItemsForDeviceComplete(syncItems)

Event method fired when register sync items for device completes.

Parameters:
syncItems: An array of ecm.model.SyncItem objects registered for the device.

onUnregisterObjectComplete()

Event method fired when unregister object completes.

onUnregisterSyncItemsForDeviceComplete(syncItems)

Event method fired when unregister sync items for device completes.

Parameters:
syncItems: An array of ecm.model.SyncItem objects unregistered for the device.

registerObject(registrationId, item, callback, params)

Registers an object with the sync server.

Parameters:
registrationId: The ID assigned by the sync server to the registered object.
item: An ecm.model.Item object to register.
callback: Callback function triggered when this method completes.
params: Object containing parameters to pass to the ecm.model.Request object.

registerSyncItemsForDevice(syncItems, deviceId, callback, params)

Registers an array of ecm.model.SyncItem objects for a device.

Parameters:
syncItems: The array of ecm.model.SyncItem objects to register.
deviceId: The device ID to register.
callback: Callback function triggered when the call completes.
params: Object containing parameters to pass to the ecm.model.Request object.

unregisterObject(registrationId, item, callback, params)

Unregisters an object with the sync server.

Parameters:
registrationId: The ID assigned by the sync server to the registered object.
item: An ecm.model.Item object to register.
callback: Callback function triggered when this method completes.
params: Object containing parameters to pass to the ecm.model.Request object.

unregisterSyncItemsForDevice(syncItems, deviceId, callback, params)

Unregisters an array of ecm.model.SyncItem objects for a device.

Parameters:
syncItems: The array of ecm.model.SyncItem objects to unregister.
deviceId: The device ID to unregister.
callback: Callback function triggered when the call completes.
params: Object containing parameters to pass to the ecm.model.Request object.