A common base class for synchronous modules.
- Namespace
- Statiq
.Common - Interfaces
- Base Types
-
- object
- Module
- Derived Types
graph BT
Type-->Base0["Module"]
click Base0 "/api/Statiq.Common/Module"
Base0-->Base1["object"]
Type-.->Interface0["IModule"]
click Interface0 "/api/Statiq.Common/IModule"
Type["SyncModule"]
class Type type-node
Derived0["TakeDocuments"]-->Type
click Derived0 "/api/Statiq.Core/TakeDocuments"
Derived1["ReadDataModule<TModule, TItem>"]-->Type
click Derived1 "/api/Statiq.Common/ReadDataModule_2"
Derived2["PaginateDocuments"]-->Type
click Derived2 "/api/Statiq.Core/PaginateDocuments"
Derived3["FlattenTree"]-->Type
click Derived3 "/api/Statiq.Core/FlattenTree"
Derived4["RemoveTreePlaceholders"]-->Type
click Derived4 "/api/Statiq.Core/RemoveTreePlaceholders"
Derived5["SyncParentModule"]-->Type
click Derived5 "/api/Statiq.Common/SyncParentModule"
Derived6["ReadApplicationInput"]-->Type
click Derived6 "/api/Statiq.Core/ReadApplicationInput"
Derived7["GatherDocuments"]-->Type
click Derived7 "/api/Statiq.Testing/GatherDocuments"
Derived8["ApplyDirectoryMetadata"]-->Type
click Derived8 "/api/Statiq.Web.Modules/ApplyDirectoryMetadata"
Syntax
public abstract class SyncModule : Module, IModuleRemarks
Documents can either be processed one at a time by overriding
ExecuteInput(IDocument, IExecutionContext) or all
at once by overriding ExecuteContext(IExecutionContext).
Methods
| Name | Return Value | Summary |
|---|---|---|
| AfterExecution |
void |
Called after each module execution.
Inherited from Module
|
| AfterExecutionAsync |
Task |
Called after each module execution.
Inherited from Module
|
| BeforeExecution |
void |
Called before each module execution.
Inherited from Module
|
| BeforeExecutionAsync |
Task |
Called before each module execution.
Inherited from Module
|
| ExecuteAsync |
Task |
This should not be called directly, instead call
IExecutionContext.Execute() if you need to execute a module from within another module.
Inherited from Module
|
| ExecuteContext |
IEnumerable |
Executes the module once for all input documents.
|
| ExecuteContextAsync |
Task |
Executes the module once for all input documents.
|
| ExecuteInput |
IEnumerable |
Executes the module.
|
| ExecuteInputAsync |
Task |
Executes the module.
|
| Finally |
void |
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
|
| FinallyAsync |
Task |
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
|