Table of Contents

Class Builder

Namespace
The.Web.Composition
Assembly
Instagile.Web.Client.dll
public sealed class Builder : IBuilder<Builder>
Inheritance
Builder
Implements
Inherited Members
Extension Methods

Constructors

Builder()

Construct a service bundle builder.

public Builder()

Builder(IServiceCollection?)

Construct a service bundle builder, with an IoC container into which its dependencies will be registered.

public Builder(IServiceCollection? container)

Parameters

container IServiceCollection

Methods

Build() 

public Root Build()

Returns

Root

BuildOptions() 

public Options BuildOptions()

Returns

Options

Configure(Action<Options>) 

public Builder Configure(Action<Options> configure)

Parameters

configure Action<Options>

Returns

Builder

RegisterAuthentication(Func<IAuthentication, IAuthentication>)

Optionally provide an IAuthentication to use for login. Principals will still be derived from the HttpContext, but logging in can set the User of that context.

public Builder RegisterAuthentication(Func<IAuthentication, IAuthentication> authentication)

Parameters

authentication Func<IAuthentication, IAuthentication>

Returns

Builder

Remarks

The factory delegate is given the default WebAuthentication in case it wants to wrap it.

RegisterAuthentication(IAuthentication)

Optionally provide an IAuthentication to use for login. Principals will still be derived from the HttpContext, but logging in can set the User of that context.

public Builder RegisterAuthentication(IAuthentication authentication)

Parameters

authentication IAuthentication

Returns

Builder

RegisterAuthorisation(IAuthorisation)

Optionally provide an IAuthorisation to use for checking resource access.

public Builder RegisterAuthorisation(IAuthorisation authorisation)

Parameters

authorisation IAuthorisation

Returns

Builder

RegisterCommandOverrides(IEnumerable<ICommandSpec>) 

public Builder RegisterCommandOverrides(IEnumerable<ICommandSpec> overrides)

Parameters

overrides IEnumerable<ICommandSpec>

Returns

Builder

RegisterCoreServices(Root, object?) 

public Builder RegisterCoreServices(Root services, object? key = null)

Parameters

services Root
key object

Returns

Builder

RegisterCriteriaOverrides(IEnumerable<ICriteriaSpec>) 

public Builder RegisterCriteriaOverrides(IEnumerable<ICriteriaSpec> overrides)

Parameters

overrides IEnumerable<ICriteriaSpec>

Returns

Builder

RegisterDocumentStore(IDocumentStore)

Optionally provide an IDocumentStore to use instead of the default NoDocumentStore for reading and writing documents.

public Builder RegisterDocumentStore(IDocumentStore documentStore)

Parameters

documentStore IDocumentStore

Returns

Builder

RegisterEditOverrides(IEnumerable<IEditSpec>) 

public Builder RegisterEditOverrides(IEnumerable<IEditSpec> overrides)

Parameters

overrides IEnumerable<IEditSpec>

Returns

Builder

RegisterEndpoint(Func<IServiceProvider, IEndpoint>)

Optionally provide an IEndpoint to use for making RPC calls. This will be used for RemoteEntityStore if no other entitystore is specified.

public Builder RegisterEndpoint(Func<IServiceProvider, IEndpoint> endpoint)

Parameters

endpoint Func<IServiceProvider, IEndpoint>

Returns

Builder

RegisterEntityStore(IEntityStore)

Optionally provide an IEntityStore to use for reading and writing entities. If an endpoint is registered, RemoteEntityStore will be used by default.

public Builder RegisterEntityStore(IEntityStore store)

Parameters

store IEntityStore

Returns

Builder

RegisterJSRuntime(IJSRuntime) 

public Builder RegisterJSRuntime(IJSRuntime jsRuntime)

Parameters

jsRuntime IJSRuntime

Returns

Builder

RegisterListOverrides(IEnumerable<IListSpec>) 

public Builder RegisterListOverrides(IEnumerable<IListSpec> overrides)

Parameters

overrides IEnumerable<IListSpec>

Returns

Builder

RegisterLoggerFactory(ILoggerFactory) 

public Builder RegisterLoggerFactory(ILoggerFactory loggerFactory)

Parameters

loggerFactory ILoggerFactory

Returns

Builder

RegisterMailer(IMailer)

Optionally provide an IMailer to use for sending email.

public Builder RegisterMailer(IMailer mailer)

Parameters

mailer IMailer

Returns

Builder

RegisterMetadata(EntityMetadataDictionary)

Provide the generated entity metadata.

public Builder RegisterMetadata(EntityMetadataDictionary metadata)

Parameters

metadata EntityMetadataDictionary

Returns

Builder

RegisterNavigationManager(NavigationManager) 

public Builder RegisterNavigationManager(NavigationManager navigationManager)

Parameters

navigationManager NavigationManager

Returns

Builder

RegisterPageOverrides(IEnumerable<IPageSpec>) 

public Builder RegisterPageOverrides(IEnumerable<IPageSpec> overrides)

Parameters

overrides IEnumerable<IPageSpec>

Returns

Builder

RegisterPersistentCache(IPersistentCache?)

Optionally provide an an external store to keep entity cache entries outside of memory.

public Builder RegisterPersistentCache(IPersistentCache? persistentCache)

Parameters

persistentCache IPersistentCache

Returns

Builder

RegisterPreferenceStore(IPreferenceStore)

Optionally provide an IPreferenceStore to use instead of the default entity-based or in-memory store for reading and writing preferences.

public Builder RegisterPreferenceStore(IPreferenceStore preferenceStore)

Parameters

preferenceStore IPreferenceStore

Returns

Builder

RegisterReminderSource(IReminderSource)

Optionally provide an IReminderSource instead of the default NoReminderSource to provide pushed reminder-update notifications.

public Builder RegisterReminderSource(IReminderSource reminderSource)

Parameters

reminderSource IReminderSource

Returns

Builder

RegisterReminderStore(IReminderStore)

Optionally provide an IReminderStore to use for querying reminder counts. If an endpoint is registered, RemoteReminderStore will used by default; otherwise, the default is LocalReminderStore.

public Builder RegisterReminderStore(IReminderStore reminderStore)

Parameters

reminderStore IReminderStore

Returns

Builder

RegisterTransientCache(TransientCache?)

Optionally replace or remove the built in memory-based entity cache.

public Builder RegisterTransientCache(TransientCache? memoryCache)

Parameters

memoryCache TransientCache

Returns

Builder

RemoveRPC(Procedure)

Deregister a built-in remote procedure.

public Builder RemoveRPC(Procedure procedure)

Parameters

procedure Procedure

Returns

Builder

Seal(IClaimsPrincipalAccessor?, IEndpoint?)

Copy core services to a core builder, which may then be used to RegisterCoreServices(Root, object?).

public Builder Seal(IClaimsPrincipalAccessor? injectedAccessor, IEndpoint? injectedRegisteredEndpoint)

Parameters

injectedAccessor IClaimsPrincipalAccessor
injectedRegisteredEndpoint IEndpoint

Returns

Builder

WithLicenceChallengeResponse(string) 

public Builder WithLicenceChallengeResponse(string encodedResponse)

Parameters

encodedResponse string

Returns

Builder

WithLicenceFile(string) 

public Builder WithLicenceFile(string licenseFile)

Parameters

licenseFile string

Returns

Builder

WithLicenceResource(Assembly, string) 

public Builder WithLicenceResource(Assembly embeddedResourceLocation, string embeddedResourceName)

Parameters

embeddedResourceLocation Assembly
embeddedResourceName string

Returns

Builder