Search Results for

    Show / Hide Table of Contents
    View Source

    Class UmbracoBuilderExtensions

    Inheritance
    object
    Namespace: Umbraco.Extensions
    Assembly: Umbraco.Cms.Api.Delivery.dll
    Syntax
    public static class UmbracoBuilderExtensions

    Methods

    View Source

    AddBackOffice(IUmbracoBuilder, Action<IMvcBuilder>?)

    Adds all required components to run the Umbraco back office

    Declaration
    public static IUmbracoBuilder AddBackOffice(this IUmbracoBuilder builder, Action<IMvcBuilder>? configureMvc = null)
    Parameters
    Type Name Description
    IUmbracoBuilder builder
    Action<IMvcBuilder> configureMvc
    Returns
    Type Description
    IUmbracoBuilder
    View Source

    AddBackOfficeCore(IUmbracoBuilder)

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

    AddBackOfficeExternalLogins(IUmbracoBuilder, Action<BackOfficeExternalLoginsBuilder>)

    Adds support for external login providers in Umbraco

    Declaration
    public static IUmbracoBuilder AddBackOfficeExternalLogins(this IUmbracoBuilder umbracoBuilder, Action<BackOfficeExternalLoginsBuilder> builder)
    Parameters
    Type Name Description
    IUmbracoBuilder umbracoBuilder
    Action<BackOfficeExternalLoginsBuilder> builder
    Returns
    Type Description
    IUmbracoBuilder
    View Source

    AddBackOfficeIdentity(IUmbracoBuilder)

    Adds Identity support for Umbraco back office

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

    AddDeliveryApi(IUmbracoBuilder)

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

    AddHelpers(IUmbracoBuilder)

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

    AddMemberExternalLogins(IUmbracoBuilder, Action<MemberExternalLoginsBuilder>)

    Adds support for external login providers in Umbraco

    Declaration
    public static IUmbracoBuilder AddMemberExternalLogins(this IUmbracoBuilder umbracoBuilder, Action<MemberExternalLoginsBuilder> builder)
    Parameters
    Type Name Description
    IUmbracoBuilder umbracoBuilder
    Action<MemberExternalLoginsBuilder> builder
    Returns
    Type Description
    IUmbracoBuilder
    View Source

    AddMembersIdentity(IUmbracoBuilder)

    Adds Identity support for Umbraco members

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

    AddMvcAndRazor(IUmbracoBuilder, Action<IMvcBuilder>?)

    Declaration
    public static IUmbracoBuilder AddMvcAndRazor(this IUmbracoBuilder builder, Action<IMvcBuilder>? mvcBuilding = null)
    Parameters
    Type Name Description
    IUmbracoBuilder builder
    Action<IMvcBuilder> mvcBuilding
    Returns
    Type Description
    IUmbracoBuilder
    View Source

    AddTwoFactorProvider<T>(BackOfficeIdentityBuilder, string)

    Declaration
    public static BackOfficeIdentityBuilder AddTwoFactorProvider<T>(this BackOfficeIdentityBuilder identityBuilder, string providerName) where T : class, ITwoFactorProvider
    Parameters
    Type Name Description
    BackOfficeIdentityBuilder identityBuilder
    string providerName
    Returns
    Type Description
    BackOfficeIdentityBuilder
    Type Parameters
    Name Description
    T
    View Source

    AddUmbraco(IServiceCollection, IWebHostEnvironment, IConfiguration)

    Creates an IUmbracoBuilder and registers basic Umbraco services

    Declaration
    public static IUmbracoBuilder AddUmbraco(this IServiceCollection services, IWebHostEnvironment webHostEnvironment, IConfiguration config)
    Parameters
    Type Name Description
    IServiceCollection services
    IWebHostEnvironment webHostEnvironment
    IConfiguration config
    Returns
    Type Description
    IUmbracoBuilder
    View Source

    AddUmbracoCore(IUmbracoBuilder)

    Adds core Umbraco services

    Declaration
    public static IUmbracoBuilder AddUmbracoCore(this IUmbracoBuilder builder)
    Parameters
    Type Name Description
    IUmbracoBuilder builder
    Returns
    Type Description
    IUmbracoBuilder
    Remarks

    This will not add any composers/components

    View Source

    AddUmbracoHybridCache(IUmbracoBuilder)

    Adds Umbraco NuCache dependencies

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

    AddUmbracoManagementApi(IUmbracoBuilder)

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

    AddUmbracoProfiler(IUmbracoBuilder)

    Adds the Umbraco request profiler

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

    AddWebComponents(IUmbracoBuilder)

    Adds all web based services required for Umbraco to run

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

    AddWebsite(IUmbracoBuilder)

    Add services for the umbraco front-end website

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

    FlagProviders(IUmbracoBuilder)

    Gets the flag providers collection builder.

    Declaration
    public static FlagProviderCollectionBuilder FlagProviders(this IUmbracoBuilder builder)
    Parameters
    Type Name Description
    IUmbracoBuilder builder

    The builder.

    Returns
    Type Description
    FlagProviderCollectionBuilder
    View Source

    Mappers(IUmbracoBuilder)

    Gets the mappers collection builder.

    Declaration
    public static MapperCollectionBuilder Mappers(this IUmbracoBuilder builder)
    Parameters
    Type Name Description
    IUmbracoBuilder builder

    The builder.

    Returns
    Type Description
    MapperCollectionBuilder
    View Source

    NPocoMappers(IUmbracoBuilder)

    Gets the NPoco mappers collection builder.

    Declaration
    public static NPocoMapperCollectionBuilder NPocoMappers(this IUmbracoBuilder builder)
    Parameters
    Type Name Description
    IUmbracoBuilder builder

    The builder.

    Returns
    Type Description
    NPocoMapperCollectionBuilder
    View Source

    PackageMigrationPlans(IUmbracoBuilder)

    Gets the package migration plans collection builder.

    Declaration
    public static PackageMigrationPlanCollectionBuilder PackageMigrationPlans(this IUmbracoBuilder builder)
    Parameters
    Type Name Description
    IUmbracoBuilder builder

    The builder.

    Returns
    Type Description
    PackageMigrationPlanCollectionBuilder
    View Source

    RuntimeModeValidators(IUmbracoBuilder)

    Gets the runtime mode validators collection builder.

    Declaration
    public static RuntimeModeValidatorCollectionBuilder RuntimeModeValidators(this IUmbracoBuilder builder)
    Parameters
    Type Name Description
    IUmbracoBuilder builder

    The builder.

    Returns
    Type Description
    RuntimeModeValidatorCollectionBuilder
    View Source

    SignProviders(IUmbracoBuilder)

    Gets the sign providers collection builder.

    Declaration
    [Obsolete("Please use the correctly named FlagProviders. Scheduled for removal in Umbraco 19.")]
    public static FlagProviderCollectionBuilder SignProviders(this IUmbracoBuilder builder)
    Parameters
    Type Name Description
    IUmbracoBuilder builder

    The builder.

    Returns
    Type Description
    FlagProviderCollectionBuilder
    • Edit this page
    • View Source
    In this article
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX