Class EntityChangeEventHelper

Used to trigger entity change events.

Inheritance

System.Object

EntityChangeEventHelper

Implements

IEntityChangeEventHelper

ITransientDependency

Namespace: Volo.Abp.Domain.Entities.Events

Assembly: Volo.Abp.Ddd.Domain.dll

Syntax

public class EntityChangeEventHelper : object, IEntityChangeEventHelper, ITransientDependency

Constructors

EntityChangeEventHelper(IUnitOfWorkManager, IEntityToEtoMapper, IOptions<AbpDistributedEntityEventOptions>)

Declaration

public EntityChangeEventHelper(IUnitOfWorkManager unitOfWorkManager, IEntityToEtoMapper entityToEtoMapper, IOptions<AbpDistributedEntityEventOptions> distributedEntityEventOptions)

Parameters

Type	Name	Description
IUnitOfWorkManager	unitOfWorkManager
IEntityToEtoMapper	entityToEtoMapper
IOptions<AbpDistributedEntityEventOptions>	distributedEntityEventOptions

Properties

DistributedEntityEventOptions

Declaration

protected AbpDistributedEntityEventOptions DistributedEntityEventOptions { get; }

Property Value

Type	Description
AbpDistributedEntityEventOptions

DistributedEventBus

Declaration

public IDistributedEventBus DistributedEventBus { get; set; }

Property Value

Type	Description
IDistributedEventBus

EntityToEtoMapper

Declaration

protected IEntityToEtoMapper EntityToEtoMapper { get; }

Property Value

Type	Description
IEntityToEtoMapper

LocalEventBus

Declaration

public ILocalEventBus LocalEventBus { get; set; }

Property Value

Type	Description
ILocalEventBus

Logger

Declaration

public ILogger<EntityChangeEventHelper> Logger { get; set; }

Property Value

Type	Description
ILogger<EntityChangeEventHelper>

UnitOfWorkManager

Declaration

protected IUnitOfWorkManager UnitOfWorkManager { get; }

Property Value

Type	Description
IUnitOfWorkManager

Methods

TriggerDistributedEvents(List<DomainEventEntry>)

Declaration

protected virtual Task TriggerDistributedEvents(List<DomainEventEntry> distributedEvents)

Parameters

Type	Name	Description
List<DomainEventEntry>	distributedEvents

Returns

Type	Description
Task

TriggerEntityChangeEvents(List<EntityChangeEntry>)

Declaration

protected virtual Task TriggerEntityChangeEvents(List<EntityChangeEntry> changedEntities)

Parameters

Type	Name	Description
List<EntityChangeEntry>	changedEntities

Returns

Type	Description
Task

TriggerEntityCreatedEventOnUowCompletedAsync(Object)

Declaration

public virtual Task TriggerEntityCreatedEventOnUowCompletedAsync(object entity)

Parameters

Type	Name	Description
System.Object	entity

Returns

Type	Description
Task

TriggerEntityCreatingEventAsync(Object)

Declaration

public virtual Task TriggerEntityCreatingEventAsync(object entity)

Parameters

Type	Name	Description
System.Object	entity

Returns

Type	Description
Task

TriggerEntityDeletedEventOnUowCompletedAsync(Object)

Declaration

public virtual Task TriggerEntityDeletedEventOnUowCompletedAsync(object entity)

Parameters

Type	Name	Description
System.Object	entity

Returns

Type	Description
Task

TriggerEntityDeletingEventAsync(Object)

Declaration

public virtual Task TriggerEntityDeletingEventAsync(object entity)

Parameters

Type	Name	Description
System.Object	entity

Returns

Type	Description
Task

TriggerEntityUpdatedEventOnUowCompletedAsync(Object)

Declaration

public virtual Task TriggerEntityUpdatedEventOnUowCompletedAsync(object entity)

Parameters

Type	Name	Description
System.Object	entity

Returns

Type	Description
Task

TriggerEntityUpdatingEventAsync(Object)

Declaration

public virtual Task TriggerEntityUpdatingEventAsync(object entity)

Parameters

Type	Name	Description
System.Object	entity

Returns

Type	Description
Task

TriggerEventsAsync(EntityChangeReport)

Declaration

public Task TriggerEventsAsync(EntityChangeReport changeReport)

Parameters

Type	Name	Description
EntityChangeReport	changeReport

Returns

Type	Description
Task

TriggerEventsInternalAsync(EntityChangeReport)

Declaration

protected virtual Task TriggerEventsInternalAsync(EntityChangeReport changeReport)

Parameters

Type	Name	Description
EntityChangeReport	changeReport

Returns

Type	Description
Task

TriggerEventWithEntity(IEventBus, Type, Object, Object, Boolean)

Declaration

protected virtual Task TriggerEventWithEntity(IEventBus eventPublisher, Type genericEventType, object entityOrEto, object originalEntity, bool triggerInCurrentUnitOfWork)

Parameters

Type	Name	Description
IEventBus	eventPublisher
Type	genericEventType
System.Object	entityOrEto
System.Object	originalEntity
System.Boolean	triggerInCurrentUnitOfWork

Returns

Type	Description
Task

TriggerLocalEvents(List<DomainEventEntry>)

Declaration

protected virtual Task TriggerLocalEvents(List<DomainEventEntry> localEvents)

Parameters

Type	Name	Description
List<DomainEventEntry>	localEvents

Returns

Type	Description
Task

Implements

IEntityChangeEventHelper

ITransientDependency

Extension Methods

AbpObjectExtensions.As<T>(Object)

AbpObjectExtensions.To<T>(Object)

AbpObjectExtensions.IsIn<T>(T, T[])

AbpObjectExtensions.If<T>(T, Boolean, Func<T, T>)

AbpObjectExtensions.If<T>(T, Boolean, Action<T>)

LockExtensions.Locking(Object, Action)

LockExtensions.Locking<T>(T, Action<T>)

LockExtensions.Locking<TResult>(Object, Func<TResult>)

LockExtensions.Locking<T, TResult>(T, Func<T, TResult>)