View Source

Class UmbracoBuilderExtensions

Contains extensions methods for IUmbracoBuilder.

Inheritance
System.Object
Namespace: Umbraco.Cms.Core.DependencyInjection
Assembly: Umbraco.Core.dll
Syntax
public static class UmbracoBuilderExtensions

Methods

View Source

Actions(IUmbracoBuilder)

Gets the actions collection builder.

Declaration
public static ActionCollectionBuilder Actions(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder

The builder.
Returns
Type Description
ActionCollectionBuilder
View Source

AddComponent<T>(IUmbracoBuilder)

Register a component.

Declaration
public static IUmbracoBuilder AddComponent<T>(this IUmbracoBuilder builder)
    where T : IComponent
Parameters
Type Name Description
IUmbracoBuilder builder

The builder.
Returns
Type Description
IUmbracoBuilder

The builder.
Type Parameters
Name Description
T

The type of the component.
View Source

AddComposers(IUmbracoBuilder)

Adds Umbraco composers for plugins

Declaration
public static IUmbracoBuilder AddComposers(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder
Returns
Type Description
IUmbracoBuilder
View Source

AddConfiguration(IUmbracoBuilder)

Add Umbraco configuration services and options

Declaration
public static IUmbracoBuilder AddConfiguration(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder
Returns
Type Description
IUmbracoBuilder
View Source

AddContentFinder<T>(IUmbracoBuilder)

Register a content finder.

Declaration
public static IUmbracoBuilder AddContentFinder<T>(this IUmbracoBuilder builder)
    where T : IContentFinder
Parameters
Type Name Description
IUmbracoBuilder builder

The builder.
Returns
Type Description
IUmbracoBuilder

The builder.
Type Parameters
Name Description
T

The type of the content finder.
View Source

AddDynamicRootStep<T>(IUmbracoBuilder)

Add an IDynamicRootQueryStep to the DynamicRootQueryStepCollectionBuilder.

Declaration
public static IUmbracoBuilder AddDynamicRootStep<T>(this IUmbracoBuilder builder)
    where T : IDynamicRootQueryStep
Parameters
Type Name Description
IUmbracoBuilder builder
Returns
Type Description
IUmbracoBuilder
Type Parameters
Name Description
T
View Source

AddEmbedProvider<T>(IUmbracoBuilder)

Register a embed provider.

Declaration
public static IUmbracoBuilder AddEmbedProvider<T>(this IUmbracoBuilder builder)
    where T : IEmbedProvider
Parameters
Type Name Description
IUmbracoBuilder builder

The builder.
Returns
Type Description
IUmbracoBuilder

The builder.
Type Parameters
Name Description
T

The type of the embed provider.
View Source

AddMapDefinition<T>(IUmbracoBuilder)

Add a map definition.

Declaration
public static IUmbracoBuilder AddMapDefinition<T>(this IUmbracoBuilder builder)
    where T : IMapDefinition
Parameters
Type Name Description
IUmbracoBuilder builder

The builder.
Returns
Type Description
IUmbracoBuilder

The builder.
Type Parameters
Name Description
T

The type of map definition.
View Source

AddMediaUrlProvider<T>(IUmbracoBuilder)

Register a media URL provider.

Declaration
public static IUmbracoBuilder AddMediaUrlProvider<T>(this IUmbracoBuilder builder)
    where T : IMediaUrlProvider
Parameters
Type Name Description
IUmbracoBuilder builder

The builder.
Returns
Type Description
IUmbracoBuilder

The builder.
Type Parameters
Name Description
T

The type of the media URL provider.
View Source

AddNotificationAsyncHandler<TNotification, TNotificationAsyncHandler>(IUmbracoBuilder)

Registers a notification async handler against the Umbraco service collection.

Declaration
public static IUmbracoBuilder AddNotificationAsyncHandler<TNotification, TNotificationAsyncHandler>(this IUmbracoBuilder builder)
    where TNotification : INotification where TNotificationAsyncHandler : INotificationAsyncHandler<TNotification>
Parameters
Type Name Description
IUmbracoBuilder builder

The Umbraco builder.
Returns
Type Description
IUmbracoBuilder

The IUmbracoBuilder.
Type Parameters
Name Description
TNotification

The type of notification.
TNotificationAsyncHandler

The type of notification async handler.
View Source

AddNotificationHandler<TNotification, TNotificationHandler>(IUmbracoBuilder)

Registers a notification handler against the Umbraco service collection.

Declaration
public static IUmbracoBuilder AddNotificationHandler<TNotification, TNotificationHandler>(this IUmbracoBuilder builder)
    where TNotification : INotification where TNotificationHandler : INotificationHandler<TNotification>
Parameters
Type Name Description
IUmbracoBuilder builder

The Umbraco builder.
Returns
Type Description
IUmbracoBuilder

The IUmbracoBuilder.
Type Parameters
Name Description
TNotification

The type of notification.
TNotificationHandler

The type of notificiation handler.
View Source

AddUrlProvider<T>(IUmbracoBuilder)

Register a URL provider.

Declaration
public static IUmbracoBuilder AddUrlProvider<T>(this IUmbracoBuilder builder)
    where T : IUrlProvider
Parameters
Type Name Description
IUmbracoBuilder builder

The Builder.
Returns
Type Description
IUmbracoBuilder

The builder.
Type Parameters
Name Description
T

The type of the URL provider.
View Source

AddWebhookEvent<T>(IUmbracoBuilder)

Add a webhook event.

Declaration
public static IUmbracoBuilder AddWebhookEvent<T>(this IUmbracoBuilder builder)
    where T : IWebhookEvent
Parameters
Type Name Description
IUmbracoBuilder builder

The builder.
Returns
Type Description
IUmbracoBuilder

The builder.
Type Parameters
Name Description
T

The type of webhook event.
View Source

CacheRefreshers(IUmbracoBuilder)

Gets the cache refreshers collection builder.

Declaration
public static CacheRefresherCollectionBuilder CacheRefreshers(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder

The builder.
Returns
Type Description
CacheRefresherCollectionBuilder
View Source

Components(IUmbracoBuilder)

Gets the components collection builder.

Declaration
public static ComponentCollectionBuilder Components(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder
Returns
Type Description
ComponentCollectionBuilder
View Source

ContentFinders(IUmbracoBuilder)

Gets the content finders collection builder.

Declaration
public static ContentFinderCollectionBuilder ContentFinders(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder

The builder.
Returns
Type Description
ContentFinderCollectionBuilder
View Source

ContentIndexHandlers(IUmbracoBuilder)

Gets the Delivery API content index handler collection builder

Declaration
public static ContentIndexHandlerCollectionBuilder ContentIndexHandlers(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder
Returns
Type Description
ContentIndexHandlerCollectionBuilder
View Source

DataEditors(IUmbracoBuilder)

Gets the data editor collection builder.

Declaration
public static DataEditorCollectionBuilder DataEditors(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder

The builder.
Returns
Type Description
DataEditorCollectionBuilder
View Source

DataValueReferenceFactories(IUmbracoBuilder)

Gets the data value reference factory collection builder.

Declaration
public static DataValueReferenceFactoryCollectionBuilder DataValueReferenceFactories(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder

The builder.
Returns
Type Description
DataValueReferenceFactoryCollectionBuilder
View Source

DynamicRootOriginFinders(IUmbracoBuilder)

Declaration
public static DynamicRootOriginFinderCollectionBuilder DynamicRootOriginFinders(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder
Returns
Type Description
DynamicRootOriginFinderCollectionBuilder
View Source

DynamicRootSteps(IUmbracoBuilder)

Declaration
public static DynamicRootQueryStepCollectionBuilder DynamicRootSteps(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder
Returns
Type Description
DynamicRootQueryStepCollectionBuilder
View Source

EditorValidators(IUmbracoBuilder)

Gets the editor validators collection builder.

Declaration
public static EditorValidatorCollectionBuilder EditorValidators(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder

The builder.
Returns
Type Description
EditorValidatorCollectionBuilder
View Source

EmbedProviders(IUmbracoBuilder)

Gets the backoffice Embed Providers collection builder.

Declaration
public static EmbedProvidersCollectionBuilder EmbedProviders(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder

The builder.
Returns
Type Description
EmbedProvidersCollectionBuilder
View Source

FilterHandlers(IUmbracoBuilder)

Gets the Delivery API filter handler collection builder

Declaration
public static FilterHandlerCollectionBuilder FilterHandlers(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder
Returns
Type Description
FilterHandlerCollectionBuilder
View Source

HealthCheckNotificationMethods(IUmbracoBuilder)

Declaration
public static HealthCheckNotificationMethodCollectionBuilder HealthCheckNotificationMethods(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder
Returns
Type Description
HealthCheckNotificationMethodCollectionBuilder
View Source

HealthChecks(IUmbracoBuilder)

Gets the health checks collection builder.

Declaration
public static HealthCheckCollectionBuilder HealthChecks(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder

The builder.
Returns
Type Description
HealthCheckCollectionBuilder
View Source

MapDefinitions(IUmbracoBuilder)

Gets the map definitions collection builder.

Declaration
public static MapDefinitionCollectionBuilder MapDefinitions(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder

The builder.
Returns
Type Description
MapDefinitionCollectionBuilder
View Source

MediaUrlGenerators(IUmbracoBuilder)

Gets the content finders collection builder.

Declaration
public static MediaUrlGeneratorCollectionBuilder MediaUrlGenerators(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder

The builder.
Returns
Type Description
MediaUrlGeneratorCollectionBuilder
View Source

MediaUrlProviders(IUmbracoBuilder)

Gets the media url providers collection builder.

Declaration
public static MediaUrlProviderCollectionBuilder MediaUrlProviders(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder

The builder.
Returns
Type Description
MediaUrlProviderCollectionBuilder
View Source

PartialViewSnippets(IUmbracoBuilder)

Gets the partial view snippets collection builder.

Declaration
public static PartialViewSnippetCollectionBuilder PartialViewSnippets(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder

The builder.
Returns
Type Description
PartialViewSnippetCollectionBuilder
View Source

PropertyValueConverters(IUmbracoBuilder)

Gets the property value converters collection builder.

Declaration
public static PropertyValueConverterCollectionBuilder PropertyValueConverters(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder

The builder.
Returns
Type Description
PropertyValueConverterCollectionBuilder
View Source

SelectorHandlers(IUmbracoBuilder)

Gets the Delivery API selector handler collection builder

Declaration
public static SelectorHandlerCollectionBuilder SelectorHandlers(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder
Returns
Type Description
SelectorHandlerCollectionBuilder
View Source

SortHandlers(IUmbracoBuilder)

Gets the Delivery API sort handler collection builder

Declaration
public static SortHandlerCollectionBuilder SortHandlers(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder
Returns
Type Description
SortHandlerCollectionBuilder
View Source

UrlProviders(IUmbracoBuilder)

Gets the URL providers collection builder.

Declaration
public static UrlProviderCollectionBuilder UrlProviders(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder

The builder.
Returns
Type Description
UrlProviderCollectionBuilder
View Source

UrlSegmentProviders(IUmbracoBuilder)

Gets the url segment providers collection builder.

Declaration
public static UrlSegmentProviderCollectionBuilder UrlSegmentProviders(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder

The builder.
Returns
Type Description
UrlSegmentProviderCollectionBuilder
View Source

WebhookEvents(IUmbracoBuilder)

Gets the backoffice sections/applications collection builder.

Declaration
public static WebhookEventCollectionBuilder WebhookEvents(this IUmbracoBuilder builder)
Parameters
Type Name Description
IUmbracoBuilder builder

The builder.
Returns
Type Description
WebhookEventCollectionBuilder