Class ChronicleClientWebApplicationBuilderExtensions

Namespace

Microsoft.AspNetCore.Builder

Assembly

Cratis.Chronicle.AspNetCore.dll

Extensions for using Cratis.Chronicle with a WebApplicationBuilder.

public static class ChronicleClientWebApplicationBuilderExtensions

Inheritance

object

ChronicleClientWebApplicationBuilderExtensions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Fields

DefaultSectionPaths

Gets the default section path for the Chronicle configuration.

public static readonly string[] DefaultSectionPaths

Field Value

string[]

Methods

AddCratisChronicle(WebApplicationBuilder, Action<ChronicleAspNetCoreOptions>?, string?, Action<IChronicleBuilder>?)

Configures the usage of Cratis for the app.

public static WebApplicationBuilder AddCratisChronicle(this WebApplicationBuilder builder, Action<ChronicleAspNetCoreOptions>? configureOptions = null, string? configSection = null, Action<IChronicleBuilder>? configure = null)

Parameters

builder WebApplicationBuilder

WebApplicationBuilder to build on.

configureOptions Action<ChronicleAspNetCoreOptions>

Optional Action<T> for configuring options.

configSection string

Optional config section.

configure Action<IChronicleBuilder>

Optional delegate for configuring the IChronicleBuilder.

Returns

WebApplicationBuilder

WebApplicationBuilder for configuration continuation.

AddCratisChronicle(WebApplicationBuilder, Action<ChronicleAspNetCoreOptions>?, string?, Action<IChronicleBuilder>?, string)

Configures the Chronicle client using a named connection string as the fallback endpoint.

public static WebApplicationBuilder AddCratisChronicle(this WebApplicationBuilder builder, Action<ChronicleAspNetCoreOptions>? configureOptions, string? configSection, Action<IChronicleBuilder>? configure, string connectionStringName)

Parameters

builder WebApplicationBuilder

WebApplicationBuilder to configure Chronicle on.

configureOptions Action<ChronicleAspNetCoreOptions>

Optional callback whose connection string overrides configuration.

configSection string

Optional configuration section path override. Defaults to Cratis:Chronicle.

configure Action<IChronicleBuilder>

Optional delegate for configuring the IChronicleBuilder.

connectionStringName string

Name under ConnectionStrings, typically the Aspire resource name.

Returns

WebApplicationBuilder

The same WebApplicationBuilder for configuration continuation.

UseCratisChronicle(IApplicationBuilder)

Configures Chronicle startup and, when automatic middleware is disabled, installs its middleware at this position.

public static IApplicationBuilder UseCratisChronicle(this IApplicationBuilder app)

Parameters

app IApplicationBuilder

IApplicationBuilder to extend.

Returns

IApplicationBuilder

IApplicationBuilder for continuation.

Remarks

Call after routing, authentication, and authorization when the namespace depends on the authenticated user.