DovetailContextBuilder Methods

1. Docs
2. /Search C# APIs
3. /Joinery.Dovetail
4. /DovetailContextBuilder
5. /Methods

ClassMethods11 members

Builder that can be used to create a context.

AppendJoint(IEnumerable<IDovetailJointMetadata>)DovetailContextBuilder

Adds a set of conventions to the scanner

public sealed class DovetailContextBuilder
{
    public DovetailContextBuilder AppendJoint(
        params IEnumerable<IDovetailJointMetadata> conventions)
    {
        // ...
    }
}

Parameters

conventionsIEnumerable<IDovetailJointMetadata>The conventions.

Returns

DovetailContextBuilderIDovetailScanner.

AppendJoint(IEnumerable<IDovetailJoint>)DovetailContextBuilder

Adds a set of conventions to the scanner

public sealed class DovetailContextBuilder
{
    public DovetailContextBuilder AppendJoint(
        params IEnumerable<IDovetailJoint> conventions)
    {
        // ...
    }
}

Parameters

conventionsIEnumerable<IDovetailJoint>The conventions.

Returns

DovetailContextBuilderIDovetailScanner.

AppendJointDovetailContextBuilder

Adds a set of conventions to the scanner

public sealed class DovetailContextBuilder
{
    public DovetailContextBuilder AppendJoint<T>()
    {
        // ...
    }
}

Returns

DovetailContextBuilderDovetailContextBuilder.

Create(IEnumerable<IDovetailJointMetadata>, IDictionary<object, object>, DovetailHostType, IEnumerable<DovetailCategory>)staticDovetailContextBuilder

Create a default context builder

public sealed class DovetailContextBuilder
{
    public static DovetailContextBuilder Create(
        IEnumerable<IDovetailJointMetadata> conventions,
        IDictionary<object, object> properties,
        DovetailHostType hostType,
        IEnumerable<DovetailCategory> categories)
    {
        // ...
    }
}

Parameters

conventionsIEnumerable<IDovetailJointMetadata>The joints to seed the builder with.

propertiesIDictionary<object, object>The initial set of properties to populate the context with.

hostTypeDovetailHostTypeThe host type the resulting context should be scoped to.

categoriesIEnumerable<DovetailCategory> The categories of joints the resulting context loads besides the Core joints, which are always loaded. An empty set loads the Application joints as well.

Returns

DovetailContextBuilderA new DovetailContextBuilder.

Create(IEnumerable<IDovetailJointMetadata>, IDictionary<object, object>, IEnumerable<DovetailCategory>)staticDovetailContextBuilder

Create a default context builder

public sealed class DovetailContextBuilder
{
    public static DovetailContextBuilder Create(
        IEnumerable<IDovetailJointMetadata> conventions,
        IDictionary<object, object> properties,
        IEnumerable<DovetailCategory> categories)
    {
        // ...
    }
}

Parameters

conventionsIEnumerable<IDovetailJointMetadata>The joints to seed the builder with.

propertiesIDictionary<object, object>The initial set of properties to populate the context with.

categoriesIEnumerable<DovetailCategory> The categories of joints the resulting context loads besides the Core joints, which are always loaded. An empty set loads the Application joints as well.

Returns

DovetailContextBuilderA new DovetailContextBuilder.

CreateAsync(CancellationToken)ValueTask<IDovetailContext>

Create a new IDovetailContext

public sealed class DovetailContextBuilder
{
    public ValueTask<IDovetailContext> CreateAsync(
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

cancellationTokenCancellationTokenoptionalThe cancellation token used during setup.

Returns

ValueTask<IDovetailContext>The newly created and set up IDovetailContext.

ExceptJoint(IEnumerable<Assembly>)DovetailContextBuilder

Adds an exception to the scanner to exclude a specific convention

public sealed class DovetailContextBuilder
{
    public DovetailContextBuilder ExceptJoint(
        params IEnumerable<Assembly> assemblies)
    {
        // ...
    }
}

Parameters

assembliesIEnumerable<Assembly>The additional types to exclude.

Returns

DovetailContextBuilderDovetailContextBuilder.

ExceptJoint(IEnumerable<Type>)DovetailContextBuilder

Adds an exception to the scanner to exclude a specific convention

public sealed class DovetailContextBuilder
{
    public DovetailContextBuilder ExceptJoint(
        params IEnumerable<Type> types)
    {
        // ...
    }
}

Parameters

typesIEnumerable<Type>The additional types to exclude.

Returns

DovetailContextBuilderDovetailContextBuilder.

PrependJoint(IEnumerable<IDovetailJointMetadata>)DovetailContextBuilder

Adds a set of conventions to the scanner

public sealed class DovetailContextBuilder
{
    public DovetailContextBuilder PrependJoint(
        params IEnumerable<IDovetailJointMetadata> conventions)
    {
        // ...
    }
}

Parameters

conventionsIEnumerable<IDovetailJointMetadata>The conventions.

Returns

DovetailContextBuilderDovetailContextBuilder.

PrependJoint(IEnumerable<IDovetailJoint>)DovetailContextBuilder

Adds a set of conventions to the scanner

public sealed class DovetailContextBuilder
{
    public DovetailContextBuilder PrependJoint(
        params IEnumerable<IDovetailJoint> conventions)
    {
        // ...
    }
}

Parameters

conventionsIEnumerable<IDovetailJoint>The conventions.

Returns

DovetailContextBuilderDovetailContextBuilder.

PrependJointDovetailContextBuilder

Adds a set of conventions to the scanner

public sealed class DovetailContextBuilder
{
    public DovetailContextBuilder PrependJoint<T>()
    {
        // ...
    }
}

Returns

DovetailContextBuilderDovetailContextBuilder.