SynchronizationHelper Class

Class providing management for the synchronization.

Inheritance Hierarchy

System.Object
  CMS.Synchronization.SynchronizationHelper

Namespace: CMS.Synchronization
Assembly: CMS.Synchronization (in CMS.Synchronization.dll) Version: 9.0.0

Syntax

public static class SynchronizationHelper

The SynchronizationHelper type exposes the following members.

Properties

	Name	Description
Public property Static member	UseCheckinCheckout	Indicates whether object locking is enabled within the system.

Methods

	Name	Description
Public method Static member	AddExcludedSettingKey	Adds given setting key to the excluded keys. For excluded keys synchronization tasks are not logged.
Public method Static member	EnsureObjectVersion	Ensure object version if not existing.
Public method Static member	GetExcludedSettingKeys	Returns set of excluded setting key names. Can return null if there are no excluded keys.
Public method Static member	GetObjectBinaryXml	Gets binary XML data for given object.
Public method Static member	GetObjectData	Gets the object data for synchronization.
Public method Static member	GetObjectKey	Gets object key for specified task type.
Public method Static member	GetObjectsData	Gets the DataSet of the objects data and their child objects.
Public method Static member	GetObjectWhereCondition	Gets the where condition for specified type of object.
Public method Static member	GetObjectXml	Gets XML with data for specified object.
Public method Static member	ChangeSiteBindingObject	Changes site binding object to the parent object.
Public method Static member	CheckCreateVersion	Indicates if the object version should be created.
Public method Static member	CheckIntegrationLogging	Indicates if the integration task should be logged.
Public method Static member	CheckStagingLogging	Indicates if the staging task should be logged.
Public method Static member	IsCheckedOutByOtherUser	Returns true if the object is checked out by other user than a current user (and use checkin/out is used).
Public method Static member	IsPostProcessingAllowedForFailedTranslation	Indicates whether object can be post-processed within the process of Import/Export or Staging because of potential reference to the object of the same object type which wasn't processed yet.
Public method Static member	IsSettingKeyExcluded	Determines whether the given setting key is excluded from synchronization.
Public method Static member	LogObjectDelete	Logs the object deletion.
Public method Static member	LogObjectChange(LogObjectChangeSettings)	Logs object change for different type of synchronization.
Public method Static member	LogObjectChange(BaseInfo, TaskTypeEnum)	Logs object change.
Public method Static member	LogObjectChange(BaseInfo, TaskTypeEnum, Boolean)	Logs object change.
Public method Static member	LogObjectChange(String, Int32, DateTime, TaskTypeEnum, Boolean, Boolean, Boolean, Boolean, Boolean, Int32, Int32)	Logs the synchronization for specified group of objects.
Public method Static member	LogObjectInsert	Logs the object insert.
Public method Static member	LogObjectUpdate	Logs the object update.
Public method Static member	RemoveExcludedSettingKey	Removes given setting key from the excluded keys. For excluded keys synchronization tasks are not logged.
Public method Static member	RemoveObjectVersions	Destroy object and child object versions
Public method Static member	TouchParent	Touch the parent.
Public method Static member	TouchParentDelete	Touch the parent when deleting an object.
Public method Static member	TouchParentInsert	Touch the parent when inserting an object.
Public method Static member	TouchParentUpdate	Touch the parent when updating an object.