The engine is the primary entry point for the generation process.

Namespace

Interfaces

Implementing Types

graph BT Type-.->Interface0["IConfigurable"] click Interface0 "/api/Statiq.Common/IConfigurable" Type-.->Interface1["IExecutionState"] click Interface1 "/api/Statiq.Common/IExecutionState" Type-.->Interface2["IDocumentFactory"] click Interface2 "/api/Statiq.Common/IDocumentFactory" Type["IEngine"] class Type type-node Implementing0["TestEngine"]-.->Type click Implementing0 "/api/Statiq.Testing/TestEngine" Implementing1["Engine"]-.->Type click Implementing1 "/api/Statiq.Core/Engine"

Syntax

public interface IEngine : IConfigurable, IExecutionState, IDocumentFactory

Properties

Name	Property Type	Summary
Analyzers	IAnalyzerCollection	A collection of analyzers.
ApplicationState	IApplicationState	Gets the state of the application when it was run.
Events	IEventCollection	Gets global events and event handlers.
Logger	ILogger
Pipelines	IPipelineCollection	Gets the pipelines.
SerialExecution	bool	Executes pipeline phases and modules in serial.
Settings	ISettings	Gets the configuration and settings.
Shortcodes	IShortcodeCollection	Gets the shortcodes.

Extension Methods

Name	Value	Summary
CloneOrCreateDocument(IDocument, IContentProvider)	IDocument	From IDocumentFactoryCreateDocumentExtensions
CloneOrCreateDocument(IDocument, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From IDocumentFactoryCreateDocumentExtensions
CloneOrCreateDocument(IDocument, NormalizedPath, IContentProvider)	IDocument	From IDocumentFactoryCreateDocumentExtensions
CloneOrCreateDocument(IDocument, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From IDocumentFactoryCreateDocumentExtensions
CloneOrCreateDocument(IDocument, NormalizedPath, NormalizedPath, IContentProvider)	IDocument	From IDocumentFactoryCreateDocumentExtensions
CloneOrCreateDocument(IDocument, NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From IDocumentFactoryCreateDocumentExtensions
CloneOrCreateDocument<TDocument>(TDocument, IContentProvider)	TDocument	From IDocumentFactoryCreateDocumentExtensions
CloneOrCreateDocument<TDocument>(TDocument, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	TDocument	From IDocumentFactoryCreateDocumentExtensions
CloneOrCreateDocument<TDocument>(TDocument, NormalizedPath, IContentProvider)	TDocument	From IDocumentFactoryCreateDocumentExtensions
CloneOrCreateDocument<TDocument>(TDocument, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	TDocument	From IDocumentFactoryCreateDocumentExtensions
CloneOrCreateDocument<TDocument>(TDocument, NormalizedPath, NormalizedPath, IContentProvider)	TDocument	From IDocumentFactoryCreateDocumentExtensions
CloneOrCreateDocument<TDocument>(TDocument, NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	TDocument	From IDocumentFactoryCreateDocumentExtensions
CreateDocument(IContentProvider)	IDocument	From IDocumentFactoryCreateDocumentExtensions
CreateDocument(IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From IDocumentFactoryCreateDocumentExtensions
CreateDocument(NormalizedPath, IContentProvider)	IDocument	From IDocumentFactoryCreateDocumentExtensions
CreateDocument(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From IDocumentFactoryCreateDocumentExtensions
CreateDocument(NormalizedPath, NormalizedPath, IContentProvider)	IDocument	From IDocumentFactoryCreateDocumentExtensions
CreateDocument<TDocument>(IContentProvider)	TDocument	From IDocumentFactoryCreateDocumentExtensions
CreateDocument<TDocument>(IEnumerable<KeyValuePair<string, object>>, IContentProvider)	TDocument	From IDocumentFactoryCreateDocumentExtensions
CreateDocument<TDocument>(NormalizedPath, IContentProvider)	TDocument	From IDocumentFactoryCreateDocumentExtensions
CreateDocument<TDocument>(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	TDocument	From IDocumentFactoryCreateDocumentExtensions
CreateDocument<TDocument>(NormalizedPath, NormalizedPath, IContentProvider)	TDocument	From IDocumentFactoryCreateDocumentExtensions
GetCurrentDateTime()	DateTime	Gets the current date/time using the `CurrentDateTime` metadata setting if it's set, otherwise using the value of `ExecutionDateTime` (which is `System.DateTime.Now` at the time execution started). From IExecutionStateExtensions
GetLink(IDocument, bool)	string	Gets a link for the specified document using the document destination. This version should be used inside modules to ensure consistent link generation. Note that you can optionally include the host or not depending on if you want to generate host-specific links. By default, the host is not included so that sites work the same on any server including the preview server. From IExecutionStateGetLinkExtensions
GetLink(IMetadata, string, bool)	string	Gets a link for the specified metadata using the specified metadata value and the default settings from the configuration. This version should be used inside modules to ensure consistent link generation. Note that you can optionally include the host or not depending on if you want to generate host-specific links. By default, the host is not included so that sites work the same on any server including the preview server. From IExecutionStateGetLinkExtensions
GetLink(IMetadata, string, string, bool)	string	Gets a link for the specified metadata using the specified metadata value and the default settings from the configuration. This version should be used inside modules to ensure consistent link generation. Note that you can optionally include the host or not depending on if you want to generate host-specific links. By default, the host is not included so that sites work the same on any server including the preview server. From IExecutionStateGetLinkExtensions
GetLink(NormalizedPath, bool)	string	Converts the specified path into a string appropriate for use as a link using default settings from the configuration. This version should be used inside modules to ensure consistent link generation. Note that you can optionally include the host or not depending on if you want to generate host-specific links. By default, the host is not included so that sites work the same on any server including the preview server. From IExecutionStateGetLinkExtensions
GetLink(NormalizedPath, string, NormalizedPath, bool, bool, bool, bool, bool, bool)	string	Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration. From IExecutionStateGetLinkExtensions
GetLink(NormalizedPath, string, NormalizedPath, bool, bool, bool, bool, bool)	string	Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration. From IExecutionStateGetLinkExtensions
GetLink(NormalizedPath, string, NormalizedPath, bool, bool, bool, bool)	string	Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration. From IExecutionStateGetLinkExtensions
GetLink(NormalizedPath, string, NormalizedPath, bool, bool, bool)	string	Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration. From IExecutionStateGetLinkExtensions
GetLink(NormalizedPath, string, string, bool, bool, bool, bool, bool, bool)	string	Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration. From IExecutionStateGetLinkExtensions
GetLink(NormalizedPath, string, string, bool, bool, bool, bool, bool)	string	Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration. From IExecutionStateGetLinkExtensions
GetLink(NormalizedPath, string, string, bool, bool, bool, bool)	string	Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration. From IExecutionStateGetLinkExtensions
GetLink(NormalizedPath, string, string, bool, bool, bool)	string	Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration. From IExecutionStateGetLinkExtensions
GetLink(string, bool)	string	Converts the specified path into a string appropriate for use as a link using default settings from the configuration. This version should be used inside modules to ensure consistent link generation. Note that you can optionally include the host or not depending on if you want to generate host-specific links. By default, the host is not included so that sites work the same on any server including the preview server. From IExecutionStateGetLinkExtensions
GetLink(string, string, NormalizedPath, bool, bool, bool, bool, bool, bool)	string	Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration. From IExecutionStateGetLinkExtensions
GetLink(string, string, NormalizedPath, bool, bool, bool, bool, bool)	string	Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration. From IExecutionStateGetLinkExtensions
GetLink(string, string, NormalizedPath, bool, bool, bool, bool)	string	Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration. From IExecutionStateGetLinkExtensions
GetLink(string, string, NormalizedPath, bool, bool, bool)	string	Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration. From IExecutionStateGetLinkExtensions
GetLink(string, string, string, bool, bool, bool, bool, bool, bool)	string	Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration. From IExecutionStateGetLinkExtensions
GetLink(string, string, string, bool, bool, bool, bool, bool)	string	Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration. From IExecutionStateGetLinkExtensions
GetLink(string, string, string, bool, bool, bool, bool)	string	Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration. From IExecutionStateGetLinkExtensions
GetLink(string, string, string, bool, bool, bool)	string	Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration. From IExecutionStateGetLinkExtensions
GetLink()	string	Gets a link for the root of the site using the host and root path specified in the settings. From IExecutionStateGetLinkExtensions
LogAndCheckVersion(Assembly, string, string)	void	From IEngineExtensions
SendHttpRequestWithRetryAsync(string)	Task<HttpResponseMessage>	Sends a GET request with exponential back-off. From IExecutionStateExtensions
SendHttpRequestWithRetryAsync(Uri)	Task<HttpResponseMessage>	Sends a GET request with exponential back-off. From IExecutionStateExtensions
ThrowIfNull<IEngine>(string)	T	From GuardExtensions
ToDocument<IEngine>(IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<IEngine>(IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<IEngine>(NormalizedPath, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<IEngine>(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<IEngine>(NormalizedPath, NormalizedPath, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<IEngine>(NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions