Class CampaignOpenedEvent

Namespace

Compendium.Core.Domain.Events.Integration

Assembly

Compendium.Core.dll

Integration event raised when a campaign email is opened.

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

Inheritance

object

IntegrationEventBase

CampaignOpenedEvent

Implements

IIntegrationEvent

IEquatable<IntegrationEventBase>

IEquatable<CampaignOpenedEvent>

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

CampaignOpenedEvent(string, string, string, DateTimeOffset, string?, string?)

Integration event raised when a campaign email is opened.

public CampaignOpenedEvent(string CampaignId, string SubscriberId, string Email, DateTimeOffset OpenedAt, string? IpAddress, string? UserAgent)

Parameters

CampaignId string

The unique identifier of the campaign.

SubscriberId string

The unique identifier of the subscriber.

Email string

The subscriber's email address.

OpenedAt DateTimeOffset

The timestamp when the email was opened.

IpAddress string

The IP address from which the email was opened.

UserAgent string

The user agent string of the email client.

Properties

CampaignId

The unique identifier of the campaign.

public string CampaignId { get; init; }

Property Value

string

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

IpAddress

The IP address from which the email was opened.

public string? IpAddress { get; init; }

Property Value

string

OpenedAt

The timestamp when the email was opened.

public DateTimeOffset OpenedAt { get; init; }

Property Value

DateTimeOffset

SubscriberId

The unique identifier of the subscriber.

public string SubscriberId { get; init; }

Property Value

string

UserAgent

The user agent string of the email client.

public string? UserAgent { get; init; }

Property Value

string