LogDocumentChangeSettings Class

Class for log single document change.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractSynchronizationSettings
    CMS.DocumentEngine.BaseLogDocumentChangeSettings
      CMS.DocumentEngine.LogDocumentChangeSettings

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

Syntax

public class LogDocumentChangeSettings : BaseLogDocumentChangeSettings

The LogDocumentChangeSettings type exposes the following members.

Constructors

	Name	Description
Public method	LogDocumentChangeSettings

Properties

	Name	Description
Public property	EnsurePublishTask	If true, also the PublishDocument task is logged for Published documents under workflow along with an PublishDocument task. (Inherited from BaseLogDocumentChangeSettings.)
Public property	LogIntegration	Indicates if the integration task should be logged. By default true. (Inherited from AbstractSynchronizationSettings.)
Public property	LogStaging	Indicates if the staging task should be logged. By default true. (Inherited from AbstractSynchronizationSettings.)
Public property	Node	Tree node.
Public property	RunAsynchronously	Indicates if task logging should be executed asynchronously (in separate thread). By default true. (Inherited from AbstractSynchronizationSettings.)
Public property	ServerID	ID of the staging server where the staging task will be logged. (Inherited from AbstractSynchronizationSettings.)
Public property	TaskGroups	Staging task groups to which the staging task belongs. (Inherited from AbstractSynchronizationSettings.)
Public property	TaskParameters	Additional task parameters. (Inherited from BaseLogDocumentChangeSettings.)
Public property	TaskType	Type of the task. (Inherited from AbstractSynchronizationSettings.)
Public property	Tree	Tree provider. (Inherited from BaseLogDocumentChangeSettings.)
Public property	User	IUserInfo that will be logged with staging task. If equals to null, no user will be logged with staging task. (Inherited from AbstractSynchronizationSettings.)
Public property	WorkerCall	Indicates if in context of worker call (asynchronous task logging). (Inherited from AbstractSynchronizationSettings.)

Extension Methods

	Name	Description
Public Extension Method	InitUserAndTaskGroups	Sets TaskGroups and User for current instance of AbstractSynchronizationSettings, so the StagingTaskInfo is logged with IUserInfo and grouped in TaskGroupInfos. (Defined by AbstractSynchronizationSettingsExtensionMethods.)