Interface IEventStoreSubscriptions

Namespace
Cratis.Chronicle.EventStoreSubscriptions
Assembly
Cratis.Chronicle.dll

Defines the API for managing event store subscriptions.

public interface IEventStoreSubscriptions
Extension Methods

Methods

GetAll()

Get all subscriptions registered for this event store.

Task<IEnumerable<EventStoreSubscriptionDefinition>> GetAll()

Returns

Task<IEnumerable<EventStoreSubscriptionDefinition>>

A collection of EventStoreSubscriptionDefinition.

Subscribe(EventStoreSubscriptionId, string, Action<IEventStoreSubscriptionBuilder>?)

Subscribe to events from a source event store's outbox.

Task Subscribe(EventStoreSubscriptionId subscriptionId, string sourceEventStore, Action<IEventStoreSubscriptionBuilder>? configure = null)

Parameters

subscriptionId EventStoreSubscriptionId

The unique identifier for this subscription.

sourceEventStore string

The name of the source event store to subscribe to.

configure Action<IEventStoreSubscriptionBuilder>

Optional callback to configure the subscription (e.g. filter event types).

Returns

Task

Awaitable task.

Unsubscribe(EventStoreSubscriptionId)

Remove a subscription by its identifier.

Task Unsubscribe(EventStoreSubscriptionId subscriptionId)

Parameters

subscriptionId EventStoreSubscriptionId

The EventStoreSubscriptionId to remove.

Returns

Task

Awaitable task.