Table of Contents

Class NotificationBase

Namespace
Excalibur.Application.Requests.Notifications
Assembly
Excalibur.Application.dll

Provides a base implementation for notifications in the system.

public abstract class NotificationBase : INotification, IActivity, IAmCorrelatable, IAmMultiTenant, IIntegrationEvent, IDispatchEvent, IDispatchMessage
Inheritance
NotificationBase
Implements
Derived
Inherited Members

Remarks

Initializes a new instance of the NotificationBase class with the specified correlation ID and tenant ID.

Constructors

NotificationBase()

Initializes a new instance of the NotificationBase class with default values.

protected NotificationBase()

NotificationBase(Guid, string?)

Provides a base implementation for notifications in the system.

protected NotificationBase(Guid correlationId, string? tenantId = null)

Parameters

correlationId Guid

The correlation ID for the notification.

tenantId string

The tenant ID associated with the notification. Defaults to TenantDefaults.DefaultTenantId if not provided.

Remarks

Initializes a new instance of the NotificationBase class with the specified correlation ID and tenant ID.

Properties

ActivityDescription

Gets the description of this activity.

public virtual string ActivityDescription { get; }

Property Value

string

A detailed description of what this activity represents.

ActivityDisplayName

Gets the display name for this activity.

public virtual string ActivityDisplayName { get; }

Property Value

string

A human-readable name for display purposes.

ActivityName

Gets the name of this activity.

public string ActivityName { get; }

Property Value

string

The namespace-qualified type name (e.g., MyApp.Orders:OrderShippedNotification).

ActivityType

Gets the type of activity this notification represents.

public ActivityType ActivityType { get; }

Property Value

ActivityType

Always returns Notification for notifications.

CorrelationId

Gets the correlation identifier for this notification.

public Guid CorrelationId { get; protected init; }

Property Value

Guid

A unique identifier used to correlate this notification with other operations.

Headers

Gets the message headers.

public IReadOnlyDictionary<string, object> Headers { get; }

Property Value

IReadOnlyDictionary<string, object>

A read-only dictionary containing the notification's metadata headers.

Id

Gets the unique identifier for this notification as a GUID.

public Guid Id { get; protected init; }

Property Value

Guid

A unique identifier for this notification instance.

MessageId

Gets the unique identifier for this notification as a string.

public string MessageId { get; }

Property Value

string

The string representation of the notification's unique identifier.

MessageType

Gets the type identifier for this notification.

public string MessageType { get; }

Property Value

string

The fully qualified type name of the notification.

TenantId

Gets the tenant identifier associated with this notification.

public string? TenantId { get; protected init; }

Property Value

string

The tenant identifier, or TenantDefaults.DefaultTenantId if no tenant ID was provided.

TransactionBehavior

Gets the transaction behavior for processing this notification.

public TransactionScopeOption TransactionBehavior { get; protected init; }

Property Value

TransactionScopeOption

The transaction scope option. Defaults to Required.

TransactionIsolation

Gets the transaction isolation level for processing this notification.

public IsolationLevel TransactionIsolation { get; protected init; }

Property Value

IsolationLevel

The isolation level. Defaults to ReadCommitted.

TransactionTimeout

Gets the transaction timeout for processing this notification.

public TimeSpan TransactionTimeout { get; protected init; }

Property Value

TimeSpan

The maximum time allowed for the transaction. Defaults to 2 minutes.