Take the community feedback survey now.

AI OnAI Off

Class CatalogEventHandler

This type/member supports the EPiServer infrastructure and is not intended to be used directly from your code.

Inheritance
System.Object
CatalogEventListenerBase
CatalogEventHandler
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.Commerce.Catalog.Provider
Assembly: EPiServer.Business.Commerce.dll
Version: 10.8.0
Syntax
public class CatalogEventHandler : CatalogEventListenerBase

Constructors

CatalogEventHandler(ReferenceConverter)

This type/member supports the EPiServer infrastructure and is not intended to be used directly from your code. Initializes a new instance of the CatalogEventHandler class.

Declaration
public CatalogEventHandler(ReferenceConverter referenceConverter)
Parameters
Type Name Description
ReferenceConverter referenceConverter

The reference converter.

CatalogEventHandler(ReferenceConverter, ISynchronizedObjectInstanceCache)

This type/member supports the EPiServer infrastructure and is not intended to be used directly from your code. Initializes a new instance of the CatalogEventHandler class.

Declaration
[Obsolete("Use constructor without ISynchronizedObjectInstanceCache, this class no longer uses the cache directly. Will remain at least until April 2016.")]
public CatalogEventHandler(ReferenceConverter referenceConverter, ISynchronizedObjectInstanceCache objectInstanceCache)
Parameters
Type Name Description
ReferenceConverter referenceConverter

The reference converter.
EPiServer.Framework.Cache.ISynchronizedObjectInstanceCache objectInstanceCache

The object instance cache.

Fields

CatalogRootKey

Declaration
[Obsolete("This is no longer used. Mediachase.Commerce.Catalog.CatalogCacheKeys may be useful for dependencies. Will remain at least until March 2016.")]
public const string CatalogRootKey = "EP:CatalogEventHandlerCatalogCacheRootKey"
Field Value
Type Description
System.String

Properties

CatalogCacheRootKeyPolicy

Cache dependency for the catalog. When the main catalog item has been updated, the cache item that uses this dependency will be removed.

Declaration
[Obsolete("This is no longer used. Mediachase.Commerce.Catalog.CatalogCacheKeys may be useful for dependencies. Will remain at least until March 2016.")]
public CacheEvictionPolicy CatalogCacheRootKeyPolicy { get; }
Property Value
Type Description
EPiServer.Framework.Cache.CacheEvictionPolicy

Instance

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

Methods

AssociationDeleted(Object, DeletedAssociationEventArgs)

Implementation of the AssociationDeleted event handler of the CatalogEventListenerBase

Declaration
public override void AssociationDeleted(object source, DeletedAssociationEventArgs args)
Parameters
Type Name Description
System.Object source

The source.
DeletedAssociationEventArgs args

The DeletedAssociationEventArgs instance containing the event data.
Overrides

AssociationUpdated(Object, AssociationEventArgs)

Implementation of the AssociationUpdated event handler of the CatalogEventListenerBase

Declaration
public override void AssociationUpdated(object source, AssociationEventArgs args)
Parameters
Type Name Description
System.Object source

The source.
AssociationEventArgs args

The AssociationEventArgs instance containing the event data.
Overrides

CatalogDeleted(Object, DeletedCatalogEventArgs)

Implementation of the CatalogDeleted event handler of the CatalogEventListenerBase

Declaration
public override void CatalogDeleted(object source, DeletedCatalogEventArgs args)
Parameters
Type Name Description
System.Object source

The source.
DeletedCatalogEventArgs args

The DeletedCatalogEventArgs instance containing the event data.
Overrides

CatalogLanguageUpdated(Object, CatalogLanguageEventArgs)

Implementation of the CatalogLanguageUpdated event handler of the CatalogEventListenerBase

Declaration
public override void CatalogLanguageUpdated(object source, CatalogLanguageEventArgs args)
Parameters
Type Name Description
System.Object source

The source.
CatalogLanguageEventArgs args

The CatalogLanguageEventArgs instance containing the event data.
Overrides

CatalogUpdated(Object, CatalogEventArgs)

Implementation of the CatalogUpdated event handler of the CatalogEventListenerBase

Declaration
public override void CatalogUpdated(object source, CatalogEventArgs args)
Parameters
Type Name Description
System.Object source

The source.
CatalogEventArgs args

The CatalogEventArgs instance containing the event data.
Overrides

EntryDeleted(Object, DeletedEntryEventArgs)

Implementation of the EntryDeleted event handler of the CatalogEventListenerBase

Declaration
public override void EntryDeleted(object source, DeletedEntryEventArgs args)
Parameters
Type Name Description
System.Object source

The source.
DeletedEntryEventArgs args

The DeletedEntryEventArgs instance containing the event data.
Overrides

EntryUpdated(Object, EntryEventArgs)

Implementation of the EntryUpdated event handler of the CatalogEventListenerBase

Declaration
public override void EntryUpdated(object source, EntryEventArgs args)
Parameters
Type Name Description
System.Object source

The source.
EntryEventArgs args

The EntryEventArgs instance containing the event data.
Overrides

ExecuteWithLocalEventsDiabled(Action)

Declaration
[Obsolete("This method's name has a typo. Use ExecuteWithLocalEventsDisabled instead. Will remain at least until November 2016.")]
public virtual void ExecuteWithLocalEventsDiabled(Action action)
Parameters
Type Name Description
System.Action action

ExecuteWithLocalEventsDisabled(Action)

This type/member supports the EPiServer infrastructure and is not intended to be used directly from your code.

Executes the action with forwarding of local events temporarily disabled. This means the ContentUpdated, RelationUpdated(Object, RelationEventArgs) and AssociationUpdated(Object, AssociationEventArgs) events are not triggered on the events from EventContext.

Declaration
[Obsolete("Executing with events disabled is no longer supported. Will remain at least until April 2016.")]
public virtual void ExecuteWithLocalEventsDisabled(Action action)
Parameters
Type Name Description
System.Action action

The action.

Initialize()

This type/member supports the EPiServer infrastructure and is not intended to be used directly from your code.

Declaration
[Obsolete("Initializing this class is no longer needed. Will remain at least until March 2016.")]
public virtual void Initialize()

InitializeEvents()

This type/member supports the EPiServer infrastructure and is not intended to be used directly from your code.

Declaration
[Obsolete("Initializing this class is no longer needed. Will remain at least until March 2016.")]
protected virtual void InitializeEvents()

NodeDeleted(Object, DeletedNodeEventArgs)

Implementation of the NodeDeleted event handler of the CatalogEventListenerBase

Declaration
public override void NodeDeleted(object source, DeletedNodeEventArgs args)
Parameters
Type Name Description
System.Object source

The source.
DeletedNodeEventArgs args

The DeletedNodeEventArgs instance containing the event data.
Overrides

NodeUpdated(Object, NodeEventArgs)

Implementation of the NodeUpdated event handler of the CatalogEventListenerBase

Declaration
public override void NodeUpdated(object source, NodeEventArgs args)
Parameters
Type Name Description
System.Object source

The source.
NodeEventArgs args

The NodeEventArgs instance containing the event data.
Overrides

RelationDeleted(Object, DeletedRelationEventArgs)

Implementation of the RelationDeleted event handler of the CatalogEventListenerBase

Declaration
public override void RelationDeleted(object source, DeletedRelationEventArgs args)
Parameters
Type Name Description
System.Object source

The source.
DeletedRelationEventArgs args

The DeletedRelationEventArgs instance containing the event data.
Overrides

RelationUpdated(Object, RelationEventArgs)

Implementation of the RelationUpdated event handler of the CatalogEventListenerBase

Declaration
public override void RelationUpdated(object source, RelationEventArgs args)
Parameters
Type Name Description
System.Object source

The source.
RelationEventArgs args

The RelationEventArgs instance containing the event data.
Overrides

Events

AssociationsUpdated

Occurs when the associations of an item in ECF have been updated

Declaration
public event EventHandler<ContentEventArgs> AssociationsUpdated
Event Type
Type Description
System.EventHandler<EPiServer.ContentEventArgs>

ContentUpdated

Occurs when an item in the ECF has been updated and the corresponding content is cleared from cache.

Declaration
public event EventHandler<ContentEventArgs> ContentUpdated
Event Type
Type Description
System.EventHandler<EPiServer.ContentEventArgs>

LanguageConfigurationUpdated

Occurs when the language configuration of a catalog

Declaration
public event EventHandler<ContentEventArgs> LanguageConfigurationUpdated
Event Type
Type Description
System.EventHandler<EPiServer.ContentEventArgs>

RelationsUpdated

Occurs when the relations of an item in ECF have been updated

Declaration
public event EventHandler<ContentEventArgs> RelationsUpdated
Event Type
Type Description
System.EventHandler<EPiServer.ContentEventArgs>