Class EventTypes

Namespace

Cratis.Chronicle.Events

Assembly

Cratis.Chronicle.dll

Represents an implementation of IEventTypes.

public class EventTypes : IEventTypes

Inheritance

object

EventTypes

Implements

IEventTypes

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

EventTypes(IEventStore, IJsonSchemaGenerator, IClientArtifactsProvider, IEventTypeMigrators, bool)

Initializes a new instance of EventTypes.

public EventTypes(IEventStore eventStore, IJsonSchemaGenerator jsonSchemaGenerator, IClientArtifactsProvider clientArtifacts, IEventTypeMigrators eventTypeMigrators, bool enableEventTypeGenerationValidation = false)

Parameters

eventStore IEventStore

The IEventStore the event types belong to.

jsonSchemaGenerator IJsonSchemaGenerator

IJsonSchemaGenerator for generating JSON schemas from types.

clientArtifacts IClientArtifactsProvider

Optional IClientArtifactsProvider for the client artifacts.

eventTypeMigrators IEventTypeMigrators

IEventTypeMigrators for discovering event type migrators.

enableEventTypeGenerationValidation bool

Whether to enable event type generation chain validation on the server. Defaults to false.

Properties

All

Get all EventType discovered event types.

public IImmutableList<EventType> All { get; }

Property Value

IImmutableList<EventType>

AllClrTypes

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

public IImmutableList<Type> AllClrTypes { get; }

Property Value

IImmutableList<Type>

Methods

Discover()

Discover all event types from the entry assembly and dependencies.

public Task Discover()

Returns

Task

Awaitable task.

GetClrTypeFor(EventTypeId)

Get a Clr Type for a specific EventTypeId.

public 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.

public 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.

public 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.

public 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.

public 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.

public 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.

public Task Register()

Returns

Task

Awaitable task.