Class ChangeNotificationExtensions

Inheritance

System.Object

ChangeNotificationExtensions

Namespace: EPiServer.Events.ChangeNotification

Assembly: EPiServer.Events.dll

Version: 12.0.3

Syntax

public static class ChangeNotificationExtensions : Object

Methods

GetChangedDataType(IChangeListener)

Gets the value of the changed data type parameter.

Declaration

public static Type GetChangedDataType(this IChangeListener changeListener)

Parameters

Type	Name	Description
IChangeListener	changeListener	The IChangeListener to inspect.

Returns

Type	Description
System.Type	The value of the changed data type parameter.

Exceptions

Type	Condition
System.ArgumentException	`changeListener` does not implement IChangeListener{TChangedData,TQueuedData}, or implements multiple types of IChangeListener{TChangedData,TQueuedData}.

GetQueuedDataType(IChangeListener)

Gets the value of the queued data type parameter.

Declaration

public static Type GetQueuedDataType(this IChangeListener changeListener)

Parameters

Type	Name	Description
IChangeListener	changeListener	The IChangeListener to inspect.

Returns

Type	Description
System.Type	The value of the queued data type parameter.

Exceptions

Type	Condition
System.ArgumentException	`changeListener` does not implement IChangeListener{TChangedData,TQueuedData}, or implements multiple types of IChangeListener{TChangedData,TQueuedData}.

GetQueuedDataType(IChangeProcessor)

Gets the value of the queued data type parameter.

Declaration

public static Type GetQueuedDataType(this IChangeProcessor changeProcessor)

Parameters

Type	Name	Description
IChangeProcessor	changeProcessor	The IChangeProcessor to inspect.

Returns

Type	Description
System.Type	The value of the queued data type parameter.

Exceptions

Type	Condition
System.ArgumentException	`changeProcessor` does not implement IChangeProcessor{TQueuedData}, or implements multiple types of IChangeProcessor{TQueuedData}.

NotifyDelete<TChangedData>(IChangeNotificationManager, TChangedData)

Notifies an IChangeNotificationManager of a delete operation.

Declaration

public static void NotifyDelete<TChangedData>(this IChangeNotificationManager changeManager, TChangedData deletedItem)
    where TChangedData : class

Parameters

Type	Name	Description
IChangeNotificationManager	changeManager	The IChangeNotificationManager to notify.
TChangedData	deletedItem	The item being deleted.

Type Parameters

Name	Description
TChangedData	The type of data being deleted.

NotifyInsert<TChangedData>(IChangeNotificationManager, TChangedData)

Notifies a IChangeNotificationManager of an insert operation.

Declaration

public static void NotifyInsert<TChangedData>(this IChangeNotificationManager changeManager, TChangedData insertedItem)
    where TChangedData : class

Parameters

Type	Name	Description
IChangeNotificationManager	changeManager	The IChangeNotificationManager to notify.
TChangedData	insertedItem	The item being inserted.

Type Parameters

Name	Description
TChangedData	The type of data being inserted.

Stop(IChangeNotificationManager)

Cancels any running tasks and releases resources, waiting indefinitely for all tasks to complete.

Declaration

public static void Stop(this IChangeNotificationManager changeManager)

Parameters

Type	Name	Description
IChangeNotificationManager	changeManager

Remarks

The object does not need to be disposed once Stop has been called.

If a non-cancellable recovery is in progress, this call may wait for a very long time.