View Source

Class NewInstallStep

This is the first UI step for a brand new install

Inheritance

System.Object

InstallSetupStep

InstallSetupStep<UserModel>

Namespace: Umbraco.Cms.Infrastructure.Install.InstallSteps

Assembly: Umbraco.Infrastructure.dll

Syntax

public class NewInstallStep : InstallSetupStep<UserModel>

Remarks

By default this will show the user view which is the most basic information to configure a new install, but if an install get's interrupted because of an error, etc... and the end-user refreshes the installer then we cannot show the user screen because they've already entered that information so instead we'll display a simple continue installation view.

Constructors

NewInstallStep(IUserService, DatabaseBuilder, IHttpClientFactory, IOptions<UserPasswordConfigurationSettings>, IOptions<SecuritySettings>, IOptionsMonitor<ConnectionStrings>, ICookieManager, IBackOfficeUserManager, IDbProviderFactoryCreator, IEnumerable<IDatabaseProviderMetadata>)

Declaration

public NewInstallStep(IUserService userService, DatabaseBuilder databaseBuilder, IHttpClientFactory httpClientFactory, IOptions<UserPasswordConfigurationSettings> passwordConfiguration, IOptions<SecuritySettings> securitySettings, IOptionsMonitor<ConnectionStrings> connectionStrings, ICookieManager cookieManager, IBackOfficeUserManager userManager, IDbProviderFactoryCreator dbProviderFactoryCreator, IEnumerable<IDatabaseProviderMetadata> databaseProviderMetadata)

Parameters

Type	Name	Description
IUserService	userService
DatabaseBuilder	databaseBuilder
IHttpClientFactory	httpClientFactory
IOptions<UserPasswordConfigurationSettings>	passwordConfiguration
IOptions<SecuritySettings>	securitySettings
IOptionsMonitor<ConnectionStrings>	connectionStrings
ICookieManager	cookieManager
IBackOfficeUserManager	userManager
IDbProviderFactoryCreator	dbProviderFactoryCreator
IEnumerable<IDatabaseProviderMetadata>	databaseProviderMetadata

NewInstallStep(IUserService, DatabaseBuilder, IHttpClientFactory, IOptions<UserPasswordConfigurationSettings>, IOptions<SecuritySettings>, IOptionsMonitor<ConnectionStrings>, ICookieManager, IBackOfficeUserManager, IDbProviderFactoryCreator, IEnumerable<IDatabaseProviderMetadata>, ILocalizedTextService, IMetricsConsentService)

Declaration

public NewInstallStep(IUserService userService, DatabaseBuilder databaseBuilder, IHttpClientFactory httpClientFactory, IOptions<UserPasswordConfigurationSettings> passwordConfiguration, IOptions<SecuritySettings> securitySettings, IOptionsMonitor<ConnectionStrings> connectionStrings, ICookieManager cookieManager, IBackOfficeUserManager userManager, IDbProviderFactoryCreator dbProviderFactoryCreator, IEnumerable<IDatabaseProviderMetadata> databaseProviderMetadata, ILocalizedTextService localizedTextService, IMetricsConsentService metricsConsentService)

Parameters

Type	Name	Description
IUserService	userService
DatabaseBuilder	databaseBuilder
IHttpClientFactory	httpClientFactory
IOptions<UserPasswordConfigurationSettings>	passwordConfiguration
IOptions<SecuritySettings>	securitySettings
IOptionsMonitor<ConnectionStrings>	connectionStrings
ICookieManager	cookieManager
IBackOfficeUserManager	userManager
IDbProviderFactoryCreator	dbProviderFactoryCreator
IEnumerable<IDatabaseProviderMetadata>	databaseProviderMetadata
ILocalizedTextService	localizedTextService
IMetricsConsentService	metricsConsentService

Properties

View

Declaration

public override string View { get; }

Property Value

Type	Description
System.String

ViewModel

Return a custom view model for this step

Declaration

public override object ViewModel { get; }

Property Value

Type	Description
System.Object

Methods

ExecuteAsync(UserModel)

Declaration

public override async Task<InstallSetupResult> ExecuteAsync(UserModel user)

Parameters

Type	Name	Description
UserModel	user

Returns

Type	Description
Task<InstallSetupResult>

RequiresExecution(UserModel)

Declaration

public override bool RequiresExecution(UserModel model)

Parameters

Type	Name	Description
UserModel	model

Returns

Type	Description
System.Boolean