A common base class for synchronous modules.
- Namespace
- Statiq
.Common - Interfaces
- Base Types
-
- object
- Module
- Derived Types
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
|