HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityOptimizely GitHubOptimizely NuGetLog In

Events

This topic introduces event that are triggered when prices and inventories are updated.

Commerce-specific events are triggered when prices and inventories are updated from either the Catalog UI, Commerce Admin UI, or external APIs. The triggered events update indexed price and inventory information. The following section describe the specific events and event management for solutions with Optimizely Commerce.

Inventory events

The events are handled through the CatalogKeyEventBroadcaster class.

Listening to events

To listento new events, register your method to the event of the CatalogKeyEventBroadcaster class:

public event EventHandler<InventoryUpdateEventArgs> InventoryUpdateEvent;

To listen to remote events, first get the event from Events engine.

public void AddEvent()
      {
        Event ev = Event.Get(CatalogKeyEventBroadcaster.CatalogKeyEventGuid);
        ev.Raised += CatalogKeyEventUpdated;
      }
    
    private void CatalogKeyEventUpdated(object sender, EventNotificationEventArgs e)
      {
        var eventArgs = (CatalogKeyEventArgs)DeSerialize((byte[])e.Param);
        var inventoryUpdatedEventArgs = eventArgs as InventoryUpdateEventArgs;
        if (inventoryUpdatedEventArgs != null)
          {
            RemoteInventoryUpdated(sender, inventoryUpdatedEventArgs);
          }
      }
    
    private void RemoteInventoryUpdated(object sender, InventoryUpdateEventArgs inventoryUpdatedEventArgs)
      {
        //Your action when inventories are updated remotely.
      }
    
    protected virtual CatalogKeyEventArgs DeSerialize(byte[] buffer)
      {
        var formatter = new BinaryFormatter();
        var stream = new MemoryStream(buffer);
        return formatter.Deserialize(stream) as CatalogKeyEventArgs;
      }

Ensure that you call your AddEvent in an IInitializationModule.

Triggering events

When inventories are saved through the default implementation, the event is automatically triggered. In a custom implementation of the interface, the event must be triggered for the system to know when there are inventory changes.

To broadcast events, use the CatalogKeyEventBroadcaster class. It has one public method for triggering inventory events:

public virtual void InventoryUpdated(object source, InventoryUpdateEventArgs args)

Whenever changes are done to the inventory system, call the method to raise an event.

To trigger an event in your inventory system implementation, add the following code to your void Save(IEnumerable<InventoryRecord> records); method:

_broadcaster.InventoryUpdated(this, new InventoryUpdateEventArgs(catalogKeys.ToList()));

Pricing events

The events are handled through the CatalogKeyEventBroadcaster class.

Listening to events

To listento new events, register your method to the pricing event of the CatalogKeyEventBroadcaster class:

public event EventHandler<PriceUpdateEventArgs> PriceUpdated;

To listento remote events, first get the event from Events engine.

public void AddEvent()
      {
        Event ev = Event.Get(CatalogKeyEventBroadcaster.CatalogKeyEventGuid);
        ev.Raised += CatalogKeyEventUpdated;
      }
    
    private void CatalogKeyEventUpdated(object sender, EventNotificationEventArgs e)
      {
        var eventArgs = (CatalogKeyEventArgs)DeSerialize((byte[])e.Param);
        var priceUpdateEventArgs = eventArgs as PriceUpdateEventArgs;
        if (priceUpdateEventArgs != null)
          {
             RemotePriceUpdated(sender, priceUpdateEventArgs);
          }
      }
    
    private void RemotePriceUpdated(object sender, PriceUpdateEventArgs priceUpdatedEventArgs)
      {
         //Your action when prices are updated remotely.
      }
    
    protected virtual CatalogKeyEventArgs DeSerialize(byte[] buffer)
      {
         var formatter = new BinaryFormatter();
         var stream = new MemoryStream(buffer);
         return formatter.Deserialize(stream) as CatalogKeyEventArgs;
      }

Ensure that you call your AddEvent in an IInitializationModule.

Triggering events

When you save prices through the default implementation, the event is automatically triggered. In a custom implementation of one of these interfaces, the event must be triggered for the system to know when there are price changes.

To broadcast events, use CatalogKeyEventBroadcaster class. This class has one public method for triggering pricing events:

public virtual void OnPriceUpdated(object source, PriceUpdateEventArgs args)

Whenever changes are done to the pricing system, call the method to raise an event.

To trigger an event in your pricing system implementation, add the following code to your void SetCatalogEntryPrices(IEnumerable<CatalogKey> catalogKeys, IEnumerable<IPriceValue> priceValues); method:

_broadcaster.OnPriceUpdated(this, new PriceUpdateEventArgs(catalogKeys.ToList()));