Sets the specified metadata in each input document.
- Namespace
- Statiq
.Core - Interfaces
- Base Types
-
- object
- Module
- ParallelConfigModule
<object>
graph BT
Type-->Base0["ParallelConfigModule<object>"]
Base0-->Base1["Module"]
click Base1 "/api/Statiq.Common/Module"
Base1-->Base2["object"]
Type-.->Interface0["IModule"]
click Interface0 "/api/Statiq.Common/IModule"
Type-.->Interface1["IParallelModule"]
click Interface1 "/api/Statiq.Common/IParallelModule"
Type["SetMetadata"]
class Type type-node
Syntax
public class SetMetadata : ParallelConfigModule<object>, IModule, IParallelModuleConstructors
| Name | Summary |
|---|---|
| SetMetadata |
Uses a delegate (or value) to determine an object to be set as metadata for each document. This allows you to specify different metadata for each document depending on the input. |
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
|
| ExecuteConfigAsync |
Task |
|
| 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
|
| IgnoreNull |
SetMetadata |
Ignores null values and does not set a metadata item for them.
|
| OnlyIfNonExisting |
SetMetadata |
Only sets the new metadata value if a value doesn't already exist.
|