Class SubscriberUnsubscribedEvent

Namespace

Compendium.Core.Domain.Events.Integration

Assembly

Compendium.Core.dll

Integration event raised when a subscriber unsubscribes from a newsletter list.

public sealed record SubscriberUnsubscribedEvent : IntegrationEventBase, IIntegrationEvent, IEquatable<IntegrationEventBase>, IEquatable<SubscriberUnsubscribedEvent>

Inheritance

object

IntegrationEventBase

SubscriberUnsubscribedEvent

Implements

IIntegrationEvent

IEquatable<IntegrationEventBase>

IEquatable<SubscriberUnsubscribedEvent>

Inherited Members

IntegrationEventBase.EventId

IntegrationEventBase.OccurredOn

IntegrationEventBase.EventVersion

IntegrationEventBase.CorrelationId

IntegrationEventBase.CausationId

IntegrationEventBase.TenantId

IntegrationEventBase.SourceSystem

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SubscriberUnsubscribedEvent(string, string, string, string, DateTimeOffset, string?, string)

Integration event raised when a subscriber unsubscribes from a newsletter list.

public SubscriberUnsubscribedEvent(string SubscriberId, string Email, string ListId, string ListName, DateTimeOffset UnsubscribedAt, string? UnsubscribeReason, string UnsubscribeMethod)

Parameters

SubscriberId string

The unique identifier of the subscriber.

Email string

The subscriber's email address.

ListId string

The identifier of the list unsubscribed from.

ListName string

The name of the list.

UnsubscribedAt DateTimeOffset

The timestamp when the unsubscription occurred.

UnsubscribeReason string

The reason for unsubscribing, if provided.

UnsubscribeMethod string

The method of unsubscription (e.g., link click, API, complaint).

Properties

Email

The subscriber's email address.

public string Email { get; init; }

Property Value

string

EventType

Gets the name of the event type for serialization and routing purposes.

public override string EventType { get; }

Property Value

string

ListId

The identifier of the list unsubscribed from.

public string ListId { get; init; }

Property Value

string

ListName

The name of the list.

public string ListName { get; init; }

Property Value

string

SubscriberId

The unique identifier of the subscriber.

public string SubscriberId { get; init; }

Property Value

string

UnsubscribeMethod

The method of unsubscription (e.g., link click, API, complaint).

public string UnsubscribeMethod { get; init; }

Property Value

string

UnsubscribeReason

The reason for unsubscribing, if provided.

public string? UnsubscribeReason { get; init; }

Property Value

string

UnsubscribedAt

The timestamp when the unsubscription occurred.

public DateTimeOffset UnsubscribedAt { get; init; }

Property Value

DateTimeOffset