IHaveArgumentDirectories Interface

Summary

Interface for all commands supporting multiple directories as arguments.
graph BT Type-.->Interface0["IHaveArgument"] click Interface0 "/api/Cake.SevenZip.Arguments/IHaveArgument" Type["IHaveArgumentDirectories"] class Type type-node Implementing0["HashCommand"]-.->Type click Implementing0 "/api/Cake.SevenZip.Commands/HashCommand" Implementing1["AddCommand"]-.->Type click Implementing1 "/api/Cake.SevenZip.Commands/AddCommand" Implementing2["DeleteCommand"]-.->Type click Implementing2 "/api/Cake.SevenZip.Commands/DeleteCommand" Implementing3["UpdateCommand"]-.->Type click Implementing3 "/api/Cake.SevenZip.Commands/UpdateCommand" Implementing4["BaseAddLikeSyntaxCommand"]-.->Type click Implementing4 "/api/Cake.SevenZip.Commands/BaseAddLikeSyntaxCommand"

Syntax

public interface IHaveArgumentDirectories : IHaveArgument

Attributes

Type Description
NullableContextAttribute

Properties

Name Value Summary
Directories DirectoryPathCollection
Gets or sets the list of Directories the command operates on.

For add and update, adding a directory will add the directory itself to the root of the archive including everything in it.

DirectoryContents DirectoryPathCollection
Gets or sets the list of Directory-contents the command operates on.

For add and update, adding a directory this way will add the files of the directory to the root of the archive but not the directory itself.

Extension Methods

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