LogObjectChangeSettings Class

Class for log object change.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractSynchronizationSettings
    CMS.DataEngine.LogObjectChangeSettings

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 10.0.0

Syntax

public class LogObjectChangeSettings : AbstractSynchronizationSettings

The LogObjectChangeSettings type exposes the following members.

Constructors

	Name	Description
Public method	LogObjectChangeSettings	Constructor

Fields

	Name	Description
Public field Static member	ENABLED_SERVERS	Constant used to specify all the enabled servers.

Properties

	Name	Description
Public property	CreateVersion	Indicates if the version should be created. Default true.
Public property	DataChanged	If true, the data of the object involved has changed. Default true.
Public property	InfoObj	Info object.
Public property	IsTouchParent	Indicates if the log request originates from touching the parent object. Default false.
Public property	LogExportTask	Indicates id the export task should be logged. Default true.
Public property	LogIntegration	Indicates if the integration task should be logged. By default true. (Inherited from AbstractSynchronizationSettings.)
Public property	LogIntegrationSimpleTasks	Indicates if the simple integration task should be logged. Default true.
Public property	LogStaging	Indicates if the staging task should be logged. By default true. (Inherited from AbstractSynchronizationSettings.)
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 staging server (Or SynchronizationInfoProvider.ENABLED_SERVERS for all enabled servers) (Overrides AbstractSynchronizationSettings.ServerID.)
Public property	SiteID	Site ID of the servers.
Public property	TaskGroups	Staging task groups to which the staging task belongs. (Inherited from AbstractSynchronizationSettings.)
Public property	TaskType	Type of the task. (Inherited from AbstractSynchronizationSettings.)
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.)

Methods

	Name	Description
Public method	GetDuplicityKey	Gets the duplicity key.

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.)