DocumentSynchronizationWorker Class

Class for asynchronous document synchronization logging.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractWorker
    CMS.Synchronization.BaseSynchronizationWorker
      CMS.DocumentEngine.DocumentSynchronizationWorker

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

Syntax

public class DocumentSynchronizationWorker : BaseSynchronizationWorker

The DocumentSynchronizationWorker type exposes the following members.

Constructors

	Name	Description
Public method	DocumentSynchronizationWorker(LogDocumentChangeSettings)	Default constructor for single document.
Public method	DocumentSynchronizationWorker(LogMultipleDocumentChangeSettings)	Default constructor for multiple documents.

Properties

	Name	Description
Public property	Cancel	If true, the worker is cancelled (doesn't execute) (Inherited from AbstractWorker.)
Public property	Multiple	If true, the task runs the multiple log tasks.
Public property	MultipleSettings	Log multiple documents change settings.
Public property	OrderChange	If true, the task runs the order change task.
Public property	RunInSequence	If true, the thread is a part of the sequence and should perform the actions after the previous thread finishes. (Inherited from AbstractWorker.)
Public property	SingleSettings	Log single document change settings.

Methods

	Name	Description
Public method	GetDuplicityKey	Gets the duplicity key for the worker to eliminate duplicit queued workers. (Inherited from AbstractWorker.)
Protected method	RaiseStop	Raises OnStop event. (Inherited from AbstractWorker.)
Public method	Run	Action that runs within a contexts of CurrentUser in which was worker created and SynchronizationActionContext. (Inherited from BaseSynchronizationWorker.)
Public method	RunAsync	Runs the worker as a new thread. (Inherited from AbstractWorker.)
Protected method	RunWorkerAction	Runs the action. (Overrides BaseSynchronizationWorker.RunWorkerAction().)

Events

	Name	Description
Public event	OnStop	Raised when worker finishes. (Inherited from AbstractWorker.)