Interface IEventTypes

Namespace

Cratis.Chronicle.Events

Assembly

Cratis.Chronicle.dll

Defines a system to work with event types.

public interface IEventTypes

Properties

All

Get all EventType discovered event types.

IImmutableList<EventType> All { get; }

Property Value

IImmutableList<EventType>

AllClrTypes

Get all event types as Cratis.Chronicle.Contracts.Events.EventTypeRegistration.

IImmutableList<Type> AllClrTypes { get; }

Property Value

IImmutableList<Type>

Methods

Discover()

Discover all event types from the entry assembly and dependencies.

Task Discover()

Returns

Task

Awaitable task.

GetClrTypeFor(EventTypeId)

Get a Clr Type for a specific EventTypeId.

Type GetClrTypeFor(EventTypeId eventTypeId)

Parameters

eventTypeId EventTypeId

EventTypeId to get for.

Returns

Type

The Clr Type.

GetClrTypeFor(EventTypeId, EventTypeGeneration)

Get a Clr Type for a specific EventTypeId and EventTypeGeneration.

Type GetClrTypeFor(EventTypeId eventTypeId, EventTypeGeneration generation)

Parameters

eventTypeId EventTypeId

EventTypeId to get for.

generation EventTypeGeneration

EventTypeGeneration to get for.

Returns

Type

The Clr Type.

GetEventTypeFor(Type)

Get a EventType for a specific Clr Type.

EventType GetEventTypeFor(Type clrType)

Parameters

clrType Type

Clr Type to get for.

Returns

EventType

The EventType.

GetSchemaFor(EventTypeId)

Get the Cratis.Chronicle.Schemas.JsonSchema for an EventTypeId.

JsonSchema GetSchemaFor(EventTypeId eventTypeId)

Parameters

eventTypeId EventTypeId

EventTypeId to get for.

Returns

JsonSchema

Cratis.Chronicle.Schemas.JsonSchema for the event type.

HasFor(EventTypeId)

Check if there is a registered Clr Type for a specific EventTypeId.

bool HasFor(EventTypeId eventTypeId)

Parameters

eventTypeId EventTypeId

EventTypeId to check for.

Returns

bool

True if there is, false if not.

HasFor(Type)

Check if there is a registered EventTypeId for a specific Clr Type.

bool HasFor(Type clrType)

Parameters

clrType Type

Clr Type to check for.

Returns

bool

True if there is, false if not.

Register()

Register all event types with the Chronicle.

Task Register()

Returns

Task

Awaitable task.