IParameter Interface

Summary

Contract for a parameter
graph BT Type-.->Interface0["IMsDeployArgument"] click Interface0 "/api/Cake.MsDeploy/IMsDeployArgument" Type["IParameter"] class Type type-node Implementing0["DeclareParameter"]-.->Type click Implementing0 "/api/Cake.MsDeploy.Parameters/DeclareParameter" Implementing1["SetParameter"]-.->Type click Implementing1 "/api/Cake.MsDeploy.Parameters/SetParameter"

Syntax

public interface IParameter : IMsDeployArgument

Properties

Name Value Summary
Description string
An optional user-supplied string that describes the purpose of the parameter
Kind Nullable<ParameterKind>
specifies the parameter kind
Match string
Specifies an item to be matched
Name string
Name of the declared parameter
Scope string
The scope of the specified parameter kind

Extension Methods

Name Value Summary
Dump<IParameter>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<IParameter>(IParameter[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<IParameter>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<IParameter>(string) void
Requires the Cake.Issues addin
ThrowIfNull<IParameter>(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<IParameter>(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
ToStringWithNullMarkup() string
Requires the Cake.Issues addin