View Source

Class RuntimeState

Represents the state of the Umbraco runtime.

Inheritance
System.Object
Namespace: Umbraco.Cms.Infrastructure.Runtime
Assembly: Umbraco.Infrastructure.dll
Syntax
public class RuntimeState : IRuntimeState

Constructors

View Source

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

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)
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

Properties

View Source

BootFailedException

Gets the exception that caused the boot to fail.

Declaration
public BootFailedException BootFailedException { get; }
Property Value
Type Description
BootFailedException
View Source

CurrentMigrationState

Gets the current migration state.

Declaration
public string CurrentMigrationState { get; }
Property Value
Type Description
System.String
View Source

FinalMigrationState

Gets the final migration state.

Declaration
public string FinalMigrationState { get; }
Property Value
Type Description
System.String
View Source

Level

Gets the runtime level of execution.

Declaration
public RuntimeLevel Level { get; }
Property Value
Type Description
RuntimeLevel
View Source

Reason

Gets the reason for the runtime level of execution.

Declaration
public RuntimeLevelReason Reason { get; }
Property Value
Type Description
RuntimeLevelReason
View Source

SemanticVersion

Gets the semantic version of the executing code.

Declaration
public SemVersion SemanticVersion { get; }
Property Value
Type Description
SemVersion
View Source

StartupState

Declaration
public IReadOnlyDictionary<string, object> StartupState { get; }
Property Value
Type Description
IReadOnlyDictionary<System.String, System.Object>
View Source

Version

Declaration
public Version Version { get; }
Property Value
Type Description
Version
View Source

VersionComment

Gets the version comment of the executing code.

Declaration
public string VersionComment { get; }
Property Value
Type Description
System.String

Methods

View Source

Booting()

The initial RuntimeState

Declaration
public static RuntimeState Booting()
Returns
Type Description
RuntimeState
View Source

Configure(RuntimeLevel, RuntimeLevelReason, Nullable<Exception>)

Declaration
public void Configure(RuntimeLevel level, RuntimeLevelReason reason, Exception? bootFailedException = null)
Parameters
Type Name Description
RuntimeLevel level
RuntimeLevelReason reason
System.Nullable<Exception> bootFailedException
View Source

DetermineRuntimeLevel()

Determines the runtime level.

Declaration
public void DetermineRuntimeLevel()