Class ChangeLogSystem

A management class for the Change Log system

Inheritance
System.Object
ChangeLogSystem
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.ChangeLog
Assembly: EPiServer.dll
Version: 8.11.0
Syntax
[Obsolete("Replaced by ActivityTrackingService")]
public static class ChangeLogSystem

Properties

Dependencies

Registered dependents of the Change Log system.

Declaration
public static IEnumerable<ChangeLogDependency> Dependencies { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<ChangeLogDependency>

State

State of the Change Log system. See ChangeLogSystemState for more information.

Declaration
public static ChangeLogSystemState State { get; set; }
Property Value
Type Description
ChangeLogSystemState

Methods

AutoStart()

Start the Change Log system based on the current State value. See ChangeLogSystemState for more information.

Declaration
public static void AutoStart()

AutoStart(IContentRepository, IContentEvents)

Start the Change Log system based on the current State value. See ChangeLogSystemState for more information.

Declaration
public static void AutoStart(IContentRepository contentRepository, IContentEvents contentEvents)
Parameters
Type Name Description
IContentRepository contentRepository
IContentEvents contentEvents

AutoStop()

Stop the Change Log system based on the current State value. If State has the value of Auto then the Change Log system will be stopped if it has no registered dependencies. If State has another value then this method does nothing.

Declaration
public static void AutoStop()

IsStarted()

Returns

true
if the Change Log system has been started, otherwise
false
.

Declaration
public static bool IsStarted()
Returns
Type Description
System.Boolean

A boolean value indicating if the Change Log system has been started or not.

Stop()

Stop the Change Log system unconditionally.

Declaration
public static void Stop()

Events

RegisterDependencies

Fired when the Change Log system requires dependencies to be registered. This event will be called indirectly by the AutoStart() method when the State property has the values of Auto. Subscribers to the event should register their dependecies in the Dependencies property which will in turn cause the Change Log system to start.

Declaration
public static event EventHandler<ChangeLogDependencyEventArgs> RegisterDependencies
Event Type
Type Description
System.EventHandler<ChangeLogDependencyEventArgs>

Started

Fired when the Change Log system is started

Declaration
public static event EventHandler Started
Event Type
Type Description
System.EventHandler

StateChanged

Fired when the Change Log system's state is changed

Declaration
public static event EventHandler StateChanged
Event Type
Type Description
System.EventHandler

Stopped

Fired when the Change Log system is stopped

Declaration
public static event EventHandler Stopped
Event Type
Type Description
System.EventHandler