IIssue Interface

Assembly
Cake.Issues.dll
Namespace
Cake.Issues
Implementing Types
graph BT Type["IIssue"] class Type type-node Implementing0["Issue"]-.->Type click Implementing0 "/api/Cake.Issues/Issue"

Syntax

public interface IIssue

Properties

Name Value Summary
AdditionalInformation IReadOnlyDictionary<string, string>
AffectedFileRelativePath FilePath
Column Nullable<int>
EndColumn Nullable<int>
EndLine Nullable<int>
FileLink Uri
Identifier string
Line Nullable<int>
MessageHtml string
MessageMarkdown string
MessageText string
Priority Nullable<int>
PriorityName string
ProjectFileRelativePath FilePath
ProjectName string
ProviderName string
ProviderType string
RuleId string
RuleName string
RuleUrl Uri
Run string

Extension Methods

Name Value Summary
Dump<IIssue>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
FileDirectory() string
Requires the Cake.Issues addin
FileName() string
Requires the Cake.Issues addin
FilePath() string
Requires the Cake.Issues addin
GetExpandoObject(bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, IDictionary<string, Func<IIssue, object>>) ExpandoObject
Returns a dynamic object containing the properties of an issue.
Requires the Cake.Issues.Reporting.Generic addin
IsIn<IIssue>(IIssue[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
LineRange(bool) string
Requires the Cake.Issues addin
LineRange() string
Requires the Cake.Issues addin
Message(IssueCommentFormat) string
Requires the Cake.Issues addin
NotNull<IIssue>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<IIssue>(string) void
Requires the Cake.Issues addin
ProjectDirectory() string
Requires the Cake.Issues addin
ProjectPath() string
Requires the Cake.Issues addin
Rule() string
Requires the Cake.Issues addin
SerializeToJsonFile(FilePath) void
Requires the Cake.Issues addin
SerializeToJsonString() string
Requires the Cake.Issues addin
ThrowIfNull<IIssue>(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<IIssue>(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