SaaS CMS has officially launched! Learn more now.

AI OnAI Off

Class ActivityTrackingService

Service class for managing the lifecycle of the activity log.

Inheritance
System.Object
ActivityTrackingService
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.DataAbstraction.Activities
Assembly: EPiServer.dll
Version: 11.20.7
Syntax
[Obsolete("ActivityTrackingService will be removed as starting and stopping the service manually no longer is supported.")]
public abstract class ActivityTrackingService

Constructors

ActivityTrackingService()

Declaration
protected ActivityTrackingService()

Properties

Disabled

Gets or sets the a value indicating if this ActivityTrackingService has been disabled.

Declaration
public abstract bool Disabled { get; set; }
Property Value
Type Description
System.Boolean
Remarks

If not disabled the service will start automatically at system startup.

Disabling the service does not automatically stop the service. To stop the service, call the Stop() method.

Instance

Gets the currently configured service instance.

Declaration
public static ActivityTrackingService Instance { get; }
Property Value
Type Description
ActivityTrackingService

IsRunning

Gets a value indicating whether the ActivityTrackingService service is currently running.

Declaration
public abstract bool IsRunning { get; }
Property Value
Type Description
System.Boolean

true if this service is running; otherwise, false.

Methods

OnStarted()

Called when when the ActivityTrackingService is started.

Declaration
protected virtual void OnStarted()

OnStopped()

Called when when the ActivityTrackingService is stopped.

Declaration
protected virtual void OnStopped()

Start()

Starts the ActivityTrackingService unless it's disabled and enables all registered IActivityTracker services.

Declaration
public abstract void Start()
Remarks

The tracking service will be started on all instances if there are multiple servers in the solution.

Stop()

Stops the ActivityTrackingService and disables all registered IActivityTracker services.

Declaration
public abstract void Stop()
Remarks

The tracking service will be stopped on all instances if there are multiple servers in the solution.

Events

ModeChanged

Occurs when the Disabled of this ActivityTrackingService is updated.

Declaration
public event EventHandler ModeChanged
Event Type
Type Description
System.EventHandler

Started

Occurs when this ActivityTrackingService is started.

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

Stopped

Occurs when this ActivityTrackingService is stopped.

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

Extension Methods