View Source

Class WebCompositionExtensions

Provides extension methods to the Composition class.

Inheritance

System.Object

Namespace: Umbraco.Web

Assembly: Umbraco.Web.dll

Syntax

public static class WebCompositionExtensions

Methods

ContentApps(Composition)

Gets the content apps collection builder.

Declaration

public static ContentAppFactoryCollectionBuilder ContentApps(this Composition composition)

Parameters

Type	Name	Description
Composition	composition	The composition.

Returns

Type	Description
ContentAppFactoryCollectionBuilder

ContentFinders(Composition)

Gets the content finders collection builder.

Declaration

public static ContentFinderCollectionBuilder ContentFinders(this Composition composition)

Parameters

Type	Name	Description
Composition	composition	The composition.

Returns

Type	Description
ContentFinderCollectionBuilder

Dashboards(Composition)

Gets the backoffice dashboards collection builder.

Declaration

public static DashboardCollectionBuilder Dashboards(this Composition composition)

Parameters

Type	Name	Description
Composition	composition	The composition.

Returns

Type	Description
DashboardCollectionBuilder

FilteredControllerFactory(Composition)

Gets the filtered controller factories collection builder.

Declaration

public static FilteredControllerFactoryCollectionBuilder FilteredControllerFactory(this Composition composition)

Parameters

Type	Name	Description
Composition	composition	The composition.

Returns

Type	Description
FilteredControllerFactoryCollectionBuilder

HealthChecks(Composition)

Gets the health checks collection builder.

Declaration

public static HealthCheckCollectionBuilder HealthChecks(this Composition composition)

Parameters

Type	Name	Description
Composition	composition	The composition.

Returns

Type	Description
HealthCheckCollectionBuilder

MediaUrlProviders(Composition)

Gets the media URL providers collection builder.

Declaration

public static MediaUrlProviderCollectionBuilder MediaUrlProviders(this Composition composition)

Parameters

Type	Name	Description
Composition	composition	The composition.

Returns

Type	Description
MediaUrlProviderCollectionBuilder

OEmbedProviders(Composition)

Gets the backoffice OEmbed Providers collection builder.

Declaration

public static EmbedProvidersCollectionBuilder OEmbedProviders(this Composition composition)

Parameters

Type	Name	Description
Composition	composition	The composition.

Returns

Type	Description
EmbedProvidersCollectionBuilder

SearchableTrees(Composition)

Gets the back office searchable tree collection builder

Declaration

public static SearchableTreeCollectionBuilder SearchableTrees(this Composition composition)

Parameters

Type	Name	Description
Composition	composition

Returns

Type	Description
SearchableTreeCollectionBuilder

Sections(Composition)

Gets the backoffice sections/applications collection builder.

Declaration

public static SectionCollectionBuilder Sections(this Composition composition)

Parameters

Type	Name	Description
Composition	composition	The composition.

Returns

Type	Description
SectionCollectionBuilder

SetContentLastChanceFinder(Composition, Func<IFactory, IContentLastChanceFinder>)

Sets the content last chance finder.

Declaration

public static void SetContentLastChanceFinder(this Composition composition, Func<IFactory, IContentLastChanceFinder> factory)

Parameters

Type	Name	Description
Composition	composition	The composition.
System.Func<IFactory, IContentLastChanceFinder>	factory	A function creating a last chance finder.

SetContentLastChanceFinder(Composition, IContentLastChanceFinder)

Sets the content last chance finder.

Declaration

public static void SetContentLastChanceFinder(this Composition composition, IContentLastChanceFinder finder)

Parameters

Type	Name	Description
Composition	composition	The composition.
IContentLastChanceFinder	finder	A last chance finder.

SetContentLastChanceFinder<T>(Composition)

Sets the content last chance finder.

Declaration

public static void SetContentLastChanceFinder<T>(this Composition composition)
    where T : IContentLastChanceFinder

Parameters

Type	Name	Description
Composition	composition	The composition.

Type Parameters

Name	Description
T	The type of the content last chance finder.

SetDefaultRenderMvcController(Composition, Type)

Sets the default controller for rendering template views.

Declaration

public static void SetDefaultRenderMvcController(this Composition composition, Type controllerType)

Parameters

Type	Name	Description
Composition	composition	The composition.
System.Type	controllerType	The type of the controller.

Remarks

The controller type is registered to the container by the composition.

SetDefaultRenderMvcController<TController>(Composition)

Sets the default controller for rendering template views.

Declaration

public static void SetDefaultRenderMvcController<TController>(this Composition composition)

Parameters

Type	Name	Description
Composition	composition	The composition.

Type Parameters

Name	Description
TController	The type of the controller.

Remarks

The controller type is registered to the container by the composition.

SetPublishedSnapshotService(Composition, Func<IFactory, IPublishedSnapshotService>)

Sets the published snapshot service.

Declaration

public static void SetPublishedSnapshotService(this Composition composition, Func<IFactory, IPublishedSnapshotService> factory)

Parameters

Type	Name	Description
Composition	composition	The composition.
System.Func<IFactory, IPublishedSnapshotService>	factory	A function creating a published snapshot service.

SetPublishedSnapshotService(Composition, IPublishedSnapshotService)

Sets the published snapshot service.

Declaration

public static void SetPublishedSnapshotService(this Composition composition, IPublishedSnapshotService service)

Parameters

Type	Name	Description
Composition	composition	The composition.
IPublishedSnapshotService	service	A published snapshot service.

SetPublishedSnapshotService<T>(Composition)

Sets the published snapshot service.

Declaration

public static void SetPublishedSnapshotService<T>(this Composition composition)
    where T : IPublishedSnapshotService

Parameters

Type	Name	Description
Composition	composition	The composition.

Type Parameters

Name	Description
T	The type of the published snapshot service.

SetSiteDomainHelper(Composition, Func<IFactory, ISiteDomainHelper>)

Sets the site domain helper.

Declaration

public static void SetSiteDomainHelper(this Composition composition, Func<IFactory, ISiteDomainHelper> factory)

Parameters

Type	Name	Description
Composition	composition	The composition.
System.Func<IFactory, ISiteDomainHelper>	factory	A function creating a helper.

SetSiteDomainHelper(Composition, ISiteDomainHelper)

Sets the site domain helper.

Declaration

public static void SetSiteDomainHelper(this Composition composition, ISiteDomainHelper helper)

Parameters

Type	Name	Description
Composition	composition	The composition.
ISiteDomainHelper	helper	A helper.

SetSiteDomainHelper<T>(Composition)

Sets the site domain helper.

Declaration

public static void SetSiteDomainHelper<T>(this Composition composition)
    where T : ISiteDomainHelper

Parameters

Type	Name	Description
Composition	composition

Type Parameters

Name	Description
T	The type of the site domain helper.

TourFilters(Composition)

Gets the TourFilters collection builder.

Declaration

public static TourFilterCollectionBuilder TourFilters(this Composition composition)

Parameters

Type	Name	Description
Composition	composition

Returns

Type	Description
TourFilterCollectionBuilder

Trees(Composition)

Gets the back office tree collection builder

Declaration

public static TreeCollectionBuilder Trees(this Composition composition)

Parameters

Type	Name	Description
Composition	composition

Returns

Type	Description
TreeCollectionBuilder

UrlProviders(Composition)

Gets the URL providers collection builder.

Declaration

public static UrlProviderCollectionBuilder UrlProviders(this Composition composition)

Parameters

Type	Name	Description
Composition	composition	The composition.

Returns

Type	Description
UrlProviderCollectionBuilder