Downloads from HTTP and outputs the results as new documents.
- Namespace
- Statiq
.Core - Interfaces
- Base Types
-
- object
- Module
graph BT
Type-->Base0["Module"]
click Base0 "/api/Statiq.Common/Module"
Base0-->Base1["object"]
Type-.->Interface0["IModule"]
click Interface0 "/api/Statiq.Common/IModule"
Type["ReadWeb"]
class Type type-node
Syntax
public class ReadWeb : Module, IModuleRemarks
The original input documents are ignored and are not part of the output
of this module.
Constructors
| Name | Summary |
|---|---|
| ReadWeb |
Downloads the specified URI with the specified request header. |
| ReadWeb |
Downloads the specified URIs with a default request header. |
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
|
| CacheResponses |
ReadWeb |
Indicates whether the downloaded response should be cached between regenerations.
|
| 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
|
| ExecuteContextAsync |
Task |
Executes the module once for all input documents.
|
| ExecuteInputAsync |
Task |
Executes the module.
Inherited from 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
|
| WithRequests |
ReadWeb |
Downloads the specified requests.
|
| WithUri |
ReadWeb |
Downloads the specified URI with the specified request header.
|
| WithUris |
ReadWeb |
Downloads the specified URIs with a default request header.
|