Download Class

Summary

Downloads from HTTP and outputs the results as new documents.
Assembly
Wyam.Core.dll
Namespace
Wyam.Core.Modules.IO
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IModule"] click Interface0 "/api/Wyam.Common.Modules/IModule" Type["Download"] class Type type-node

Syntax

public class Download : IModule

Remarks

The original input documents are ignored and are not part of the output of this module. If you want to retain the original input documents, consider using the Wyam.Core.Modules.Control.ConcatBranch module.

Constructors

Name Summary
Download(string, RequestHeaders) Downloads the specified URI with the specified request header.
Download(string[]) Downloads the specified URIs with a default request header.

Methods

Name Value Summary
CacheResponses(bool) Download
Indicates whether the downloaded response should be cached between regenerations.
Execute(IReadOnlyList<IDocument>, IExecutionContext) IEnumerable<IDocument>
This should not be called directly, instead call IExecutionContext.Execute() if you need to execute a module from within another module.
WithRequests(DownloadRequest[]) Download
Downloads the specified requests.
WithUri(string, RequestHeaders) Download
Downloads the specified URI with the specified request header.
WithUris(string[]) Download
Downloads the specified URIs with a default request header.
GitHub