This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.SPCAF.

Summary

A wrapper around SPCAF functionality within a Cake build script.

Assembly

Cake.SPCAF.dll

Namespace

Cake.SPCAF

Base Types

graph BT Type-->Base0["Tool<SPCAFSettings>"] Type["SPCAFRunner"] class Type type-node

Syntax

public sealed class SPCAFRunner : Tool<SPCAFSettings>

Name	Summary
SPCAFRunner(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator)	Initializes a new instance of the `SPCAFRunner` class.

Name	Value	Summary
GetAlternativeToolPaths(SPCAFSettings)	IEnumerable<FilePath>	Uses ToolPath from setting and the typically cli tool path C:\Program Files (x86)\SPCAF\' to get alternative tool paths.
GetToolExecutableNames()	IEnumerable<string>	Possible tool executable names.
GetToolName()	string	SPCAF tool name.
Run(SPCAFSettings)	void	Starts the SPCAF run.

Name	Value	Summary
Dump<SPCAFRunner>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<SPCAFRunner>(SPCAFRunner[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<SPCAFRunner>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<SPCAFRunner>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<SPCAFRunner>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<SPCAFRunner>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin