BaseSynchronizationWorker Class

Base class for synchronization workers ensuring CurrentUser and SynchronizationActionContext availability for asynchronous actions.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractWorker
    CMS.Synchronization.BaseSynchronizationWorker
      CMS.DocumentEngine.DocumentSynchronizationWorker
      CMS.MediaLibrary.FolderTaskWorker
      CMS.Synchronization.SynchronizationWorker

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

Syntax

public abstract class BaseSynchronizationWorker : AbstractWorker

The BaseSynchronizationWorker type exposes the following members.

Constructors

	Name	Description
Protected method	BaseSynchronizationWorker

Properties

	Name	Description
Public property	Cancel	If true, the worker is cancelled (doesn't execute) (Inherited from AbstractWorker.)
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.)

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. (Overrides AbstractWorker.Run().)
Public method	RunAsync	Runs the worker as a new thread. (Inherited from AbstractWorker.)
Protected method	RunWorkerAction	Runs the worker action within the CurrentUser and SynchronizationActionContext contexts ensured on initialization of the worker instance.

Events

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