Table of Contents

Class Builder

Namespace
The.Composition
Assembly
Instagile.dll
public class Builder
Inheritance
Builder
Inherited Members

Constructors

Builder() 

public Builder()

Methods

AddRPC(Implementation) 

public Builder AddRPC(Implementation procedure)

Parameters

procedure Implementation

Returns

Builder

AddRPCs(Func<IEnumerable<Implementation>>) 

public Builder AddRPCs(Func<IEnumerable<Implementation>> deferredProcedures)

Parameters

deferredProcedures Func<IEnumerable<Implementation>>

Returns

Builder

Build(Assembly?)

Build and return an instance of core/ORM services.

public Root Build(Assembly? entryPoint = null)

Parameters

entryPoint Assembly

Returns

Root

Configure(Action<Options>) 

public Builder Configure(Action<Options> configure)

Parameters

configure Action<Options>

Returns

Builder

ConfigureLogging(Action<ILoggingBuilder>)

Configure logging providers and filters using the ILoggingBuilder API.

public Builder ConfigureLogging(Action<ILoggingBuilder> configureLogging)

Parameters

configureLogging Action<ILoggingBuilder>

An action to configure logging.

Returns

Builder

The builder.

Remarks

This method allows configuration of logging providers using extension methods that target ILoggingBuilder, such as AddConsole(), AddDebug(), or third-party providers.

Exceptions

NotSupportedException

Thrown if the default logger factory has been replaced with one that doesn't implement ILoggingBuilder.

RegisterAuthentication(IAuthentication)

Provide an IAuthentication to use for determining user identity.

public Builder RegisterAuthentication(IAuthentication authenticator)

Parameters

authenticator IAuthentication

Returns

Builder

RegisterAuthorisation(IAuthorisation)

Optionally provide an IAuthorisation to use for checking resource access.

public Builder RegisterAuthorisation(IAuthorisation authoriser)

Parameters

authoriser IAuthorisation

Returns

Builder

RegisterCacheStore(ICacheStore?)

Optionally provide persistent storage for the built-in entity cache.

public Builder RegisterCacheStore(ICacheStore? cacheStore)

Parameters

cacheStore ICacheStore

Returns

Builder

Remarks

Like CachingOptions, this will not be used if the built-in cache is replaced.

RegisterDocumentStore(IDocumentStore)

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

public Builder RegisterDocumentStore(IDocumentStore documentStore)

Parameters

documentStore IDocumentStore

Returns

Builder

RegisterEndpoint(IEndpoint)

Optionally provide an IEndpoint to use for making RPC calls.

public Builder RegisterEndpoint(IEndpoint endpoint)

Parameters

endpoint IEndpoint

Returns

Builder

RegisterEntityStore(IEntityStore)

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

public Builder RegisterEntityStore(IEntityStore entityStore)

Parameters

entityStore IEntityStore

Returns

Builder

RegisterLoggerFactory(ILoggerFactory)

Optionally replace the built in ILoggerFactory (for integrations).

public Builder RegisterLoggerFactory(ILoggerFactory loggerFactory)

Parameters

loggerFactory ILoggerFactory

Returns

Builder

RegisterMailer(IMailer) 

public Builder RegisterMailer(IMailer mailer)

Parameters

mailer IMailer

Returns

Builder

RegisterMetadata(EntityMetadataDictionary)

Provide the generated entity metadata.

public Builder RegisterMetadata(EntityMetadataDictionary infos)

Parameters

infos EntityMetadataDictionary

Returns

Builder

RegisterRoleCache(RoleCache?)

Optionally replace or remove the built in authorisation role cache.

public Builder RegisterRoleCache(RoleCache? roleCache)

Parameters

roleCache RoleCache

Returns

Builder

Remarks

This can be used to share a cache between framework instances.

RegisterScramblingState(ScramblingState) 

public Builder RegisterScramblingState(ScramblingState scramblingState)

Parameters

scramblingState ScramblingState

Returns

Builder

RegisterSharedCache(SharedCache?)

Optionally replace or remove the built in entity cache.

public Builder RegisterSharedCache(SharedCache? memoryCache)

Parameters

memoryCache SharedCache

Returns

Builder

Remarks

This can be used to share a cache between framework instances.

RemoveRPC(Procedure)

Deregister a built-in remote procedure.

public Builder RemoveRPC(Procedure procedure)

Parameters

procedure Procedure

Returns

Builder

WithLicenceChallengeResponse(string) 

public Builder WithLicenceChallengeResponse(string encodedResponse)

Parameters

encodedResponse string

Returns

Builder

WithLicenceFile(string) 

public Builder WithLicenceFile(string filePath)

Parameters

filePath string

Returns

Builder

WithLicenceResource(Assembly, string) 

public Builder WithLicenceResource(Assembly embeddedResourceLocation, string embeddedResourceName)

Parameters

embeddedResourceLocation Assembly
embeddedResourceName string

Returns

Builder