DeployNetlifySite Class
Namespace
Statiq.Web.Netlify
Interfaces
Base Types
graph BT Type-->Base0["MultiConfigModule"] click Base0 "/api/Statiq.Common/MultiConfigModule" Base0-->Base1["MultiConfigModuleBase"] click Base1 "/api/Statiq.Common/MultiConfigModuleBase" Base1-->Base2["Module"] click Base2 "/api/Statiq.Common/Module" Base2-->Base3["object"] Type-.->Interface0["IModule"] click Interface0 "/api/Statiq.Common/IModule" Type["DeployNetlifySite"] class Type type-node

Syntax

public class DeployNetlifySite : MultiConfigModule, IModule

Constructors

Name Summary
DeployNetlifySite(Config<NormalizedPath>, Config<string>, Config<string>) Deploys a specified zip file to Netlify.
DeployNetlifySite(Config<string>, Config<string>, Config<IContentProvider>) Deploys a specified zip stream to Netlify.
DeployNetlifySite(Config<string>, Config<string>, Config<IContentProviderFactory>) Deploys a specified zip stream to Netlify.
DeployNetlifySite(Config<string>, Config<string>, Config<NormalizedPath>) Deploys a specified folder to Netlify.
DeployNetlifySite(Config<string>, Config<string>) Deploys the output folder to Netlify.

Properties

Name Property Type Summary
Configs IReadOnlyDictionary<string, IConfig>
Inherited from MultiConfigModuleBase
ForceDocumentExecution bool
Inherited from MultiConfigModuleBase

Methods

Name Return Value Summary
AfterExecution(IExecutionContext, ExecutionOutputs) void
Called after each module execution.
Inherited from Module
AfterExecutionAsync(IExecutionContext, ExecutionOutputs) Task
Called after each module execution.
Inherited from Module
BeforeExecution(IExecutionContext) void
Called before each module execution.
Inherited from Module
BeforeExecutionAsync(IExecutionContext) Task
Called before each module execution.
Inherited from Module
CombineConfig<TValue>(string, Config<TValue>, Func<TValue, TValue, IDocument, IExecutionContext, Task<TValue>>) MultiConfigModuleBase
Inherited from MultiConfigModuleBase
CombineConfig<TValue>(string, Config<TValue>, Func<TValue, TValue, IDocument, IExecutionContext, TValue>) MultiConfigModuleBase
Inherited from MultiConfigModuleBase
CombineConfig<TValue>(string, Config<TValue>, Func<TValue, TValue, IExecutionContext, Task<TValue>>) MultiConfigModuleBase
Inherited from MultiConfigModuleBase
CombineConfig<TValue>(string, Config<TValue>, Func<TValue, TValue, IExecutionContext, TValue>) MultiConfigModuleBase
Inherited from MultiConfigModuleBase
CombineConfig<TValue>(string, Config<TValue>, Func<TValue, TValue, Task<TValue>>) MultiConfigModuleBase
Inherited from MultiConfigModuleBase
CombineConfig<TValue>(string, Config<TValue>, Func<TValue, TValue, TValue>) MultiConfigModuleBase
Inherited from MultiConfigModuleBase
ExecuteAsync(IExecutionContext) Task<IEnumerable<IDocument>>
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(IDocument, IExecutionContext, IMetadata) Task<IEnumerable<IDocument>>
ExecuteContextAsync(IExecutionContext) Task<IEnumerable<IDocument>>
Executes the module once for all input documents.
Inherited from MultiConfigModule
ExecuteInputAsync(IDocument, IExecutionContext) Task<IEnumerable<IDocument>>
Executes the module.
Inherited from MultiConfigModuleBase
Finally(IExecutionContext) void
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
FinallyAsync(IExecutionContext) Task
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
GetConfig(string) IConfig
Gets the config for a given key.
Inherited from MultiConfigModuleBase
GetConfig<TValue>(string) Config<TValue>
Gets the config for a given key cast to a specific config value.
Inherited from MultiConfigModuleBase
SetConfig(string, IConfig) MultiConfigModuleBase
Sets the config for a given key.
Inherited from MultiConfigModuleBase
TryGetConfig(string, IConfig) bool
Inherited from MultiConfigModuleBase

Extension Methods

Name Value Summary
ForEachDocument() ForEachDocument
ThrowIfNull<DeployNetlifySite>(string) T
ToDocument<DeployNetlifySite>(IContentProvider) IDocument
ToDocument<DeployNetlifySite>(IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
ToDocument<DeployNetlifySite>(NormalizedPath, IContentProvider) IDocument
ToDocument<DeployNetlifySite>(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
ToDocument<DeployNetlifySite>(NormalizedPath, NormalizedPath, IContentProvider) IDocument
ToDocument<DeployNetlifySite>(NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
Guide API
GitHub Twitter Get Help Support/Buy
© 2023 Statiq/Dave Glick