Class WebhookDefinition

Namespace
Cratis.Chronicle.Webhooks
Assembly
Cratis.Chronicle.dll

Represents the registration of a single client webhook observer.

public record WebhookDefinition : IEquatable<WebhookDefinition>
Inheritance
WebhookDefinition
Implements
Inherited Members
Extension Methods

Constructors

WebhookDefinition(WebhookDefinition)

protected WebhookDefinition(WebhookDefinition original)

Parameters

original WebhookDefinition

WebhookDefinition(WebhookId, IEnumerable<EventType>, WebhookTarget, EventSequenceId, bool, bool)

Represents the registration of a single client webhook observer.

public WebhookDefinition(WebhookId Identifier, IEnumerable<EventType> EventTypes, WebhookTarget Target, EventSequenceId EventSequenceId, bool IsReplayable, bool IsActive)

Parameters

Identifier WebhookId

WebhookId of the webhook.

EventTypes IEnumerable<EventType>

The type of events the observer is interested in.

Target WebhookTarget

The WebhookTarget target to send the events to.

EventSequenceId EventSequenceId

The EventSequenceId the webhook is for.

IsReplayable bool

Whether the webhook supports replay scenarios.

IsActive bool

Whether the wehbook is active.

Properties

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

EventSequenceId

The EventSequenceId the webhook is for.

public EventSequenceId EventSequenceId { get; init; }

Property Value

EventSequenceId

EventTypes

The type of events the observer is interested in.

public IEnumerable<EventType> EventTypes { get; init; }

Property Value

IEnumerable<EventType>

GenerationDelivery

Gets the policy for delivering event generations.

public EventGenerationDelivery GenerationDelivery { get; init; }

Property Value

EventGenerationDelivery

Identifier

WebhookId of the webhook.

public WebhookId Identifier { get; init; }

Property Value

WebhookId

IsActive

Whether the wehbook is active.

public bool IsActive { get; init; }

Property Value

bool

IsReplayable

Whether the webhook supports replay scenarios.

public bool IsReplayable { get; init; }

Property Value

bool

Target

The WebhookTarget target to send the events to.

public WebhookTarget Target { get; init; }

Property Value

WebhookTarget

Methods

Deconstruct(out WebhookId, out IEnumerable<EventType>, out WebhookTarget, out EventSequenceId, out bool, out bool)

public void Deconstruct(out WebhookId Identifier, out IEnumerable<EventType> EventTypes, out WebhookTarget Target, out EventSequenceId EventSequenceId, out bool IsReplayable, out bool IsActive)

Parameters

Identifier WebhookId
EventTypes IEnumerable<EventType>
Target WebhookTarget
EventSequenceId EventSequenceId
IsReplayable bool
IsActive bool

Equals(WebhookDefinition?)

public virtual bool Equals(WebhookDefinition? other)

Parameters

other WebhookDefinition

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

Operators

operator ==(WebhookDefinition?, WebhookDefinition?)

public static bool operator ==(WebhookDefinition? left, WebhookDefinition? right)

Parameters

left WebhookDefinition
right WebhookDefinition

Returns

bool

operator !=(WebhookDefinition?, WebhookDefinition?)

public static bool operator !=(WebhookDefinition? left, WebhookDefinition? right)

Parameters

left WebhookDefinition
right WebhookDefinition

Returns

bool