Interface IChangeProcessorInfo

Represents information about the current status of a processor.

Namespace: EPiServer.Events.ChangeNotification

Assembly: EPiServer.Events.dll

Version: 8.11.0

Syntax

public interface IChangeProcessorInfo

Properties

LastConsistentUtc

Gets the most recent date and time that the processor state was valid and the queue was empty, or null if that condition has not occurred.

Declaration

DateTime? LastConsistentUtc { get; }

Property Value

Type	Description
System.Nullable<System.DateTime>

Remarks

This value is reset to null when the queue is invalidated.

Name

Gets the display name of the processor.

Declaration

string Name { get; }

Property Value

Type	Description
System.String

ProcessorId

Gets the unique id of the processor.

Declaration

Guid ProcessorId { get; }

Property Value

Type	Description
System.Guid

QueuedItemCount

Gets the number of items in the processor's queue.

Declaration

int QueuedItemCount { get; }

Property Value

Type	Description
System.Int32

RecoveryProcessCompletionPercentage

If a recovery process is being run by the event manager returning this object, and the process is reporting progress messages with percentages, gets the most recently reported completion percent; otherwise, returns null.

Declaration

double? RecoveryProcessCompletionPercentage { get; }

Property Value

Type	Description
System.Nullable<System.Double>

Remarks

100% is represented as 100.0, not 1.0.

RecoveryProcessLastActivityUtc

If a recovery process is being run by the event manager returning this object, and the process is reporting progress messages, gets the most recent date and time that the process reported activity; otherwise, returns null.

Declaration

DateTime? RecoveryProcessLastActivityUtc { get; }

Property Value

Type	Description
System.Nullable<System.DateTime>

Status

Gets the current status of the processor.

Declaration

ChangeProcessorStatus Status { get; }

Property Value

Type	Description
ChangeProcessorStatus

Methods

SetInvalid()

Invalidates the processor.

Declaration

void SetInvalid()

TryStartRecovery()

Tries to start recovery of the processor, if it is invalid. If the queue is valid or already recovering, does nothing.

Declaration

void TryStartRecovery()