Interface IContentFilterBuilder

Interface with methods to build IContentFilter<TContent>.

Inherited Members

IContentTypeHookBuilder.ByContentType()

Namespace: Tableau.Migration.Engine.Hooks.Filters

Assembly: Tableau.Migration.dll

Syntax

public interface IContentFilterBuilder : IContentTypeHookBuilder

Methods

Add(Type, IEnumerable<Type[]>)

Adds a factory to resolve the filter type.

Declaration

IContentFilterBuilder Add(Type genericFilterType, IEnumerable<Type[]> contentTypes)

Parameters

Type	Name	Description
Type	genericFilterType	The generic type definition for the filter to execute.
IEnumerable<Type[]>	contentTypes	The content types used to construct the filter types.

Returns

Type	Description
IContentFilterBuilder	The same filter builder object for fluent API calls.

Add<TContent>(Func<IEnumerable<ContentMigrationItem<TContent>>, IEnumerable<ContentMigrationItem<TContent>>?>)

Adds a callback to be executed on the filter for the content type.

Declaration

IContentFilterBuilder Add<TContent>(Func<IEnumerable<ContentMigrationItem<TContent>>, IEnumerable<ContentMigrationItem<TContent>>?> callback) where TContent : IContentReference

Parameters

Type	Name	Description
Func<IEnumerable<ContentMigrationItem<TContent>>, IEnumerable<ContentMigrationItem<TContent>>>	callback	A synchronously callback to call for the filter.

Returns

Type	Description
IContentFilterBuilder	The same filter builder object for fluent API calls.

Type Parameters

Name	Description
TContent	The content type.

Add<TContent>(Func<IEnumerable<ContentMigrationItem<TContent>>, CancellationToken, Task<IEnumerable<ContentMigrationItem<TContent>>?>>)

Adds a callback to be executed one the filter for the content type.

Declaration

IContentFilterBuilder Add<TContent>(Func<IEnumerable<ContentMigrationItem<TContent>>, CancellationToken, Task<IEnumerable<ContentMigrationItem<TContent>>?>> callback) where TContent : IContentReference

Parameters

Type	Name	Description
Func<IEnumerable<ContentMigrationItem<TContent>>, CancellationToken, Task<IEnumerable<ContentMigrationItem<TContent>>>>	callback	A callback to call for the filter.

Returns

Type	Description
IContentFilterBuilder	The same filter builder object for fluent API calls.

Type Parameters

Name	Description
TContent	The content type.

Add<TContent>(IContentFilter<TContent>)

Adds an object to be resolved when you build a filter for the content type.

Declaration

IContentFilterBuilder Add<TContent>(IContentFilter<TContent> filter) where TContent : IContentReference

Parameters

Type	Name	Description
IContentFilter<TContent>	filter	The filter to execute.

Returns

Type	Description
IContentFilterBuilder	The same filter builder object for fluent API calls.

Type Parameters

Name	Description
TContent	The content type.

Add<TFilter, TContent>(Func<IServiceProvider, TFilter>?)

Adds a factory to resolve the filter type.

Declaration

IContentFilterBuilder Add<TFilter, TContent>(Func<IServiceProvider, TFilter>? filterFactory = null) where TFilter : IContentFilter<TContent> where TContent : IContentReference

Parameters

Type	Name	Description
Func<IServiceProvider, TFilter>	filterFactory	An initializer function to create the object from, potentially from the migration-scoped dependency injection container.

Returns

Type	Description
IContentFilterBuilder	The same filter builder object for fluent API calls.

Type Parameters

Name	Description
TFilter	The filter type.
TContent	The content type.

Build()

Builds an immutable collection from the currently added filters.

Declaration

IMigrationHookFactoryCollection Build()

Returns

Type	Description
IMigrationHookFactoryCollection	The created collection.

Clear()

Removes all currently registered filters.

Declaration

IContentFilterBuilder Clear()

Returns

Type	Description
IContentFilterBuilder	The same filter builder object for fluent API calls.