DocumentSynchronizationWorker Class

Class for asynchronous document synchronization logging.

Inheritance Hierarchy

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

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

Syntax

public class DocumentSynchronizationWorker : AbstractWorker

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.

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	Runs the action. (Overrides AbstractWorker.Run().)
Public method	RunAsync	Runs the worker as a new thread. (Inherited from AbstractWorker.)

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

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.

Events

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