SyncManager Class

Helper class for synchronization methods.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractManager
    CMS.Base.AbstractManager<SyncManager>
      CMS.Synchronization.SyncManager

Namespace: CMS.Synchronization
Assembly: CMS.SynchronizationEngine (in CMS.SynchronizationEngine.dll) Version: 12.0.0

Syntax

public class SyncManager : AbstractManager<SyncManager>, 
	ISyncManager

The SyncManager type exposes the following members.

Constructors

	Name	Description
Public method	SyncManager

Properties

	Name	Description
Public property	AdministratorId	Administrator user ID.
Public property	LogTasks	Indicates if logging staging tasks is enabled.
Public property	OperationType	Defines the operation type.
Public property	SiteID	Gets site ID.
Public property	SiteName	Gets or sets current site name.
Protected property	TranslationSiteID	Gets site ID for translation.
Public property	TreeProvider	TreeProvider object to use.
Public property	UseAutomaticOrdering	Indicates if automatic ordering for documents should be used on target server.
Public property	UseTreeCustomHandlers	Indicates if custom handlers should be used for document operations.
Protected property	VersionManager	Version manager instance.
Protected property	WorkflowManager	Workflow manager instance.

Methods

	Name	Description
Protected method	ArchiveDocument	Archives the document.
Protected method	ChangeManagerType<OriginalType>	Changes the default manager type to the given type (Inherited from AbstractManager.)
Public method	ChangeManagerTypeTo	Changes the manager type to the given type (Inherited from AbstractManager<ManagerType>.)
Protected method	CreateSiteBinding	Creates a site binding. (Site is specified by SyncManager.SiteID property.)
Protected method	DeleteDocument	Deletes the document.
Protected method	DeleteObject	Deletes the object.
Public method	GetDataSet	Returns the dataset loaded from the given task data.
Protected method	GetDataSetInternal	Returns the dataset loaded from the given task data.
Protected method	GetPhysicalFilesDataSet	Gets physical files DataSet.
Public method	GetSynchronizationTaskDataSet	Gets synchronization task empty DataSet for specified task type.
Protected method	GetSynchronizationTaskDataSetInternal	Gets synchronization task empty DataSet for specified task type.
Protected method	MoveDocument	Moves the document.
Public method	ProceedWithTranslations	Determines whether to continue with translation operations.
Protected method	ProcessACLItems	Break ACL inheritance.
Public method	ProcessTask(IStagingTaskData, Boolean, StagingSynchronizationHandler)	Processes the given task.
Public method	ProcessTask(TaskTypeEnum, String, String, String)	Processes the given task.
Public method	ProcessTask(TaskTypeEnum, String, String, String, Boolean)	Processes the given task.
Public method	ProcessTask(TaskTypeEnum, String, String, String, Boolean, StagingSynchronizationHandler)	Processes the given task.
Protected method	ProcessTaskInternal	Processes the given task.
Protected method	PublishDocument	Publishes the document.
Protected method	RejectDocument	Rejects the document.
Protected method	RemoveObjectFromSite(DataSet, String, TranslationHelper)	Removes the object from the site.
Protected method	RemoveObjectFromSite(GeneralizedInfo, DataSet, TranslationHelper)	Removes the object from site.
Protected method	RemoveObjectsFromSite	Removes the objects from site.
Protected method	TranslateNodeColumns	Translates given node columns using data from helper.
Protected method	UpdateACLs	Update node with permissions from DataSet.
Protected method	UpdateAliases	Updates the document aliases.
Protected method	UpdateAlternativeUrls	Updates the alternative urls during synchronization.
Protected method	UpdateCategories	Updates the categories.
Protected method	UpdateDocument	Updates the document.
Protected method	UpdateObject(DataSet, DataSet, String, TranslationHelper, Boolean, Boolean)	Updates the object.
Protected method	UpdateObject(GeneralizedInfo, DataSet, TranslationHelper, Boolean, DataSet, Boolean, List<GeneralizedInfo>)	Updates the object.
Protected method	UpdateObject<TInfo>(TInfo, DataSet, TranslationHelper, Boolean, DataSet, Boolean, List<GeneralizedInfo>)	Updates the object.
Protected method	UpdateObjects	Updates the object.
Protected method	UpdateRelationships	Updates the relationships.