View Source

Class RuntimeState

Represents the state of the Umbraco runtime.

Inheritance

object

Namespace: Umbraco.Cms.Infrastructure.Runtime

Assembly: Umbraco.Infrastructure.dll

Syntax

public class RuntimeState : IRuntimeState

Constructors

RuntimeState(IOptions<GlobalSettings>, IOptions<UnattendedSettings>, IUmbracoVersion, IUmbracoDatabaseFactory, ILogger<RuntimeState>, PendingPackageMigrations, IConflictingRouteService, IEnumerable<IDatabaseProviderMetadata>, IRuntimeModeValidationService)

Initializes a new instance of the RuntimeState class.

Declaration

[Obsolete("Please use the constructor taking all parameters. Scheduled for removal in Umbraco 18.")]
public RuntimeState(IOptions<GlobalSettings> globalSettings, IOptions<UnattendedSettings> unattendedSettings, IUmbracoVersion umbracoVersion, IUmbracoDatabaseFactory databaseFactory, ILogger<RuntimeState> logger, PendingPackageMigrations packageMigrationState, IConflictingRouteService conflictingRouteService, IEnumerable<IDatabaseProviderMetadata> databaseProviderMetadata, IRuntimeModeValidationService runtimeModeValidationService)

Parameters

Type	Name	Description
IOptions<GlobalSettings>	globalSettings
IOptions<UnattendedSettings>	unattendedSettings
IUmbracoVersion	umbracoVersion
IUmbracoDatabaseFactory	databaseFactory
ILogger<RuntimeState>	logger
PendingPackageMigrations	packageMigrationState
IConflictingRouteService	conflictingRouteService
IEnumerable<IDatabaseProviderMetadata>	databaseProviderMetadata
IRuntimeModeValidationService	runtimeModeValidationService

RuntimeState(IOptions<GlobalSettings>, IOptions<UnattendedSettings>, IUmbracoVersion, IUmbracoDatabaseFactory, ILogger<RuntimeState>, PendingPackageMigrations, IConflictingRouteService, IEnumerable<IDatabaseProviderMetadata>, IRuntimeModeValidationService, IDatabaseAvailabilityCheck)

Initializes a new instance of the RuntimeState class.

Declaration

public RuntimeState(IOptions<GlobalSettings> globalSettings, IOptions<UnattendedSettings> unattendedSettings, IUmbracoVersion umbracoVersion, IUmbracoDatabaseFactory databaseFactory, ILogger<RuntimeState> logger, PendingPackageMigrations packageMigrationState, IConflictingRouteService conflictingRouteService, IEnumerable<IDatabaseProviderMetadata> databaseProviderMetadata, IRuntimeModeValidationService runtimeModeValidationService, IDatabaseAvailabilityCheck databaseAvailabilityCheck)

Parameters

Type	Name	Description
IOptions<GlobalSettings>	globalSettings
IOptions<UnattendedSettings>	unattendedSettings
IUmbracoVersion	umbracoVersion
IUmbracoDatabaseFactory	databaseFactory
ILogger<RuntimeState>	logger
PendingPackageMigrations	packageMigrationState
IConflictingRouteService	conflictingRouteService
IEnumerable<IDatabaseProviderMetadata>	databaseProviderMetadata
IRuntimeModeValidationService	runtimeModeValidationService
IDatabaseAvailabilityCheck	databaseAvailabilityCheck

Properties

BootFailedException

Gets the exception that caused the boot to fail.

Declaration

public BootFailedException? BootFailedException { get; }

Property Value

Type	Description
BootFailedException

CurrentMigrationState

Gets the current migration state.

Declaration

public string? CurrentMigrationState { get; }

Property Value

Type	Description
string

FinalMigrationState

Gets the final migration state.

Declaration

public string? FinalMigrationState { get; }

Property Value

Type	Description
string

Level

Gets the runtime level of execution.

Declaration

public RuntimeLevel Level { get; }

Property Value

Type	Description
RuntimeLevel

Reason

Gets the reason for the runtime level of execution.

Declaration

public RuntimeLevelReason Reason { get; }

Property Value

Type	Description
RuntimeLevelReason

SemanticVersion

Gets the semantic version of the executing code.

Declaration

public SemVersion SemanticVersion { get; }

Property Value

Type	Description
SemVersion

StartupState

Returns any state data that was collected during startup

Declaration

public IReadOnlyDictionary<string, object> StartupState { get; }

Property Value

Type	Description
IReadOnlyDictionary<string, object>

Version

Gets the version of the executing code.

Declaration

public Version Version { get; }

Property Value

Type	Description
Version

VersionComment

Gets the version comment of the executing code.

Declaration

public string VersionComment { get; }

Property Value

Type	Description
string

Methods

Booting()

The initial RuntimeState

Declaration

public static RuntimeState Booting()

Returns

Type	Description
RuntimeState

Configure(RuntimeLevel, RuntimeLevelReason, Exception?)

Declaration

public void Configure(RuntimeLevel level, RuntimeLevelReason reason, Exception? bootFailedException = null)

Parameters

Type	Name	Description
RuntimeLevel	level
RuntimeLevelReason	reason
Exception	bootFailedException

DetermineRuntimeLevel()

Determines the runtime level.

Declaration

public void DetermineRuntimeLevel()